Commit f0f25b54 authored by Elisabetta Giani's avatar Elisabetta Giani
Browse files

fix-configure-after-scan: Updated CSP.LMC Common PAckage documentation.

parent fc9c4655
Loading
Loading
Loading
Loading
Loading
+15 −12
Original line number Diff line number Diff line
##############
CSP Subarrays
##############
####################
LOW CSP.LMC Subarray
####################

The core CSP functionality, configuration and execution of signal processing, is configured, controlled 
and monitored via subarrays.

@@ -16,9 +17,10 @@ Resources assignment
=====================
The assignment of Capabilities to a subarray (*subarray composition*) is performed 
in advance of a scan configuration.  
Assignable Capabilities for CSP Subarrays are:
Assignable Capabilities for LOW CSP.LMC Subarrays are:

* receptors (MID) or stations (LOW) 
* stations 
* station beams
* tied-array beams: Search Beams, Timing Beams and Vlbi Beams.

In general resource assignment to a subarray is exclusive, but in some cases the same Capability instance
@@ -26,18 +28,19 @@ may be used in shared manner by more then one subarray.

Inherent Capabilities
---------------------
Each CSP subarray has also four permanently assigned *inherent Capabilities*: 
Each CSP subarray has also five permanently assigned *inherent Capabilities*: 

* Station Beam
* Correlation
* PSS
* PST
* VLBI

An inherent Capability can be enabled or disabled, but cannot assigned or removed to/from a subarray. 
They correspond to the CSP Mid Processing Modes and are configured via a scan configuration.
They correspond to the CSP Low Processing Modes and are configured via a scan configuration.

Scan configuration
====================
==================

TM provides a complete scan configuration to a subarray via an ASCII JSON encoded string.
Parameters specified via a JSON string are implemented as TANGO Device attributes  
@@ -47,16 +50,16 @@ When a complete and coherent scan configuration is received and the subarray con

Control and Monitoring
======================
Each CSP Subarray maintains and report the status and state transitions for the 
Each Low CSP.LMC Subarray maintains and report the status and state transitions for the 
CSP subarray as a whole and for the individual assigned resources.

In addition to pre-configured status reporting, a CSP Subarray makes provision for the TM and any authorized client, 
to obtain the value of any subarray attribute.

CspSubarray Class Documentation 
================================
Low CspSubarray Class Documentation 
===================================

.. automodule:: csp_lmc_common.CspSubarray
.. autoclass:: csp_lmc_common.CspSubarray.CspSubarray
   :members:
   :undoc-members:
   :show-inheritance: