Instrument Neutral Distributed Interface INDI  1.9.5
Classes | Public Types | Public Member Functions | Public Attributes | List of all members
INDI::Correlator Class Reference

Class to provide general functionality of Monodimensional Correlator. More...

#include <indicorrelator.h>

Inheritance diagram for INDI::Correlator:
INDI::SensorInterface INDI::DefaultDevice INDI::BaseDevice

Classes

struct  Baseline
 the baseline (position of the telescopes) of this correlator. More...
 
struct  Correlation
 
union  UVCoordinate
 

Public Types

enum  { CORRELATOR_MAX_CAPABILITY = SENSOR_MAX_CAPABILITY<<0 }
 
enum  CORRELATOR_INFO_INDEX {
  CORRELATOR_BASELINE_X = 0, CORRELATOR_BASELINE_Y, CORRELATOR_BASELINE_Z, CORRELATOR_WAVELENGTH,
  CORRELATOR_BANDWIDTH
}
 
- Public Types inherited from INDI::SensorInterface
enum  {
  SENSOR_CAN_ABORT = 1<<0, SENSOR_HAS_STREAMING = 1<<1, SENSOR_HAS_SHUTTER = 1<<2, SENSOR_HAS_COOLER = 1<<3,
  SENSOR_HAS_DSP = 1<<4, SENSOR_MAX_CAPABILITY = 1<<5
}
 
enum  { CONNECTION_NONE = 1 << 0, CONNECTION_SERIAL = 1 << 1, CONNECTION_TCP = 1 << 2 }
 
- Public Types inherited from INDI::BaseDevice
enum  INDI_ERROR { INDI_DEVICE_NOT_FOUND = -1, INDI_PROPERTY_INVALID = -2, INDI_PROPERTY_DUPLICATED = -3, INDI_DISPATCH_ERROR = -4 }
 
enum  { INDI_ENABLED, INDI_DISABLED }
 
enum  DRIVER_INTERFACE {
  GENERAL_INTERFACE = 0, TELESCOPE_INTERFACE = (1 << 0), CCD_INTERFACE = (1 << 1), GUIDER_INTERFACE = (1 << 2),
  FOCUSER_INTERFACE = (1 << 3), FILTER_INTERFACE = (1 << 4), DOME_INTERFACE = (1 << 5), GPS_INTERFACE = (1 << 6),
  WEATHER_INTERFACE = (1 << 7), AO_INTERFACE = (1 << 8), DUSTCAP_INTERFACE = (1 << 9), LIGHTBOX_INTERFACE = (1 << 10),
  DETECTOR_INTERFACE = (1 << 11), ROTATOR_INTERFACE = (1 << 12), SPECTROGRAPH_INTERFACE = (1 << 13), CORRELATOR_INTERFACE = (1 << 14),
  AUX_INTERFACE = (1 << 15), SENSOR_INTERFACE = SPECTROGRAPH_INTERFACE | DETECTOR_INTERFACE | CORRELATOR_INTERFACE
}
 The DRIVER_INTERFACE enum defines the class of devices the driver implements. A driver may implement one or more interfaces. More...
 
typedef INDI::Properties Properties
 

Public Member Functions

 Correlator ()
 
virtual ~Correlator ()
 
bool initProperties () override
 Initilize properties initial state and value. The child class must implement this function. More...
 
bool updateProperties () override
 updateProperties is called whenever there is a change in the CONNECTION status of the driver. This will enable the driver to react to changes of switching ON/OFF a device. For example, a driver may only define a set of properties after a device is connected, but not before. More...
 
void ISGetProperties (const char *dev) override
 define the driver's properties to the client. Usually, only a minimum set of properties are defined to the client in this function if the device is in disconnected state. Those properties should be enough to enable the client to establish a connection to the device. In addition to CONNECT/DISCONNECT, such properties may include port name, IP address, etc. You should check if the device is already connected, and if this is true, then you must define the remainder of the the properties to the client in this function. Otherwise, the remainder of the driver's properties are defined to the client in updateProperties() function which is called when a client connects/disconnects from a device. More...
 
bool ISNewNumber (const char *dev, const char *name, double values[], char *names[], int n) override
 Process the client newNumber command. More...
 
bool ISNewSwitch (const char *dev, const char *name, ISState *states, char *names[], int n) override
 Process the client newSwitch command. More...
 
bool ISNewText (const char *dev, const char *name, char *texts[], char *names[], int n) override
 Process the client newSwitch command. More...
 
bool ISNewBLOB (const char *dev, const char *name, int sizes[], int blobsizes[], char *blobs[], char *formats[], char *names[], int n) override
 Process the client newBLOB command. More...
 
bool ISSnoopDevice (XMLEle *root) override
 Process a snoop event from INDI server. This function is called when a snooped property is updated in a snooped driver. More...
 
virtual bool StartIntegration (double duration) override
 Start integration from the Sensor device. More...
 
virtual double getCorrelationDegree ()
 getCorrelationDegree Get current correlation degree. More...
 
Correlation getCorrelation ()
 getCorrelation Get current correlation degree plus UV and baseline information. More...
 
void setBaseline (Baseline bl)
 setBaseline Set the baseline size in meters. More...
 
void setWavelength (double wl)
 setWavelength Set the observed wavelength. More...
 
void setBandwidth (double bw)
 setBandwidth Set the bandwidth of the correlator. More...
 
Baseline getBaseline ()
 setBaseline Get the baseline size in meters. More...
 
double getWavelength ()
 setWavelength Get the observed wavelength. More...
 
UVCoordinate getUVCoordinates ()
 getUVCoordinates Get current UV projected coordinates with reference to the current sidereal time. More...
 
UVCoordinate getUVCoordinates (double lst)
 getUVCoordinates Get current UV projected coordinates with reference to the given sidereal time. More...
 
UVCoordinate getUVCoordinates (double alt, double az)
 getUVCoordinates Get current UV projected coordinates with reference to zenith/azimuth baseline. More...
 
double getDelay ()
 getDelay Get current baseline delay with reference to the current sidereal time. More...
 
double getDelay (double lst)
 getUVCoordinates Get current baseline delay with reference to the given sidereal time. More...
 
double getDelay (double alt, double az)
 getUVCoordinates Get current baseline delay with reference to zenith/azimuth baseline. More...
 
double setBandwidth ()
 setBandwidth Get the bandwidth of the correlator. More...
 
INumberVectorPropertygetCorrelatorSettings ()
 Return Vector Info Property. More...
 
uint32_t GetCorrelatorCapability () const
 GetCorrelatorCapability returns the Sensor capabilities. More...
 
void SetCorrelatorCapability (uint32_t cap)
 SetCorrelatorCapability Set the Correlator capabilities. Al fields must be initilized. More...
 
void setMinMaxStep (const char *property, const char *element, double min, double max, double step, bool sendToClient)
 setMinMaxStep for a number property element More...
 
- Public Member Functions inherited from INDI::SensorInterface
 SensorInterface ()
 
 ~SensorInterface ()
 
bool initProperties ()
 Initilize properties initial state and value. The child class must implement this function. More...
 
bool updateProperties ()
 updateProperties is called whenever there is a change in the CONNECTION status of the driver. This will enable the driver to react to changes of switching ON/OFF a device. For example, a driver may only define a set of properties after a device is connected, but not before. More...
 
bool processNumber (const char *dev, const char *name, double values[], char *names[], int n)
 
void processProperties (const char *dev)
 
bool processText (const char *dev, const char *name, char *texts[], char *names[], int n)
 
bool processSwitch (const char *dev, const char *name, ISState states[], char *names[], int n)
 
bool processBLOB (const char *dev, const char *name, int sizes[], int blobsizes[], char *blobs[], char *formats[], char *names[], int n)
 
bool processSnoopDevice (XMLEle *root)
 
int getBufferSize () const
 getContinuumBufferSize Get allocated continuum buffer size to hold the Sensor integrationd stream. More...
 
double getIntegrationLeft () const
 getIntegrationLeft Get Integration time left in seconds. More...
 
double getIntegrationTime () const
 getIntegrationTime Get requested Integration duration for the Sensor device in seconds. More...
 
const char * getIntegrationStartTime ()
 getIntegrationStartTime More...
 
uint8_t * getBuffer ()
 getBuffer Get raw buffer of the stream of the Sensor device. More...
 
void setBuffer (uint8_t *buffer)
 setBuffer Set raw frame buffer pointer. More...
 
int getBPS () const
 getBPS Get Sensor depth (bits per sample). More...
 
void setMinMaxStep (const char *property, const char *element, double min, double max, double step, bool sendToClient=true)
 setMinMaxStep for a number property element More...
 
void setBufferSize (int nbuf, bool allocMem=true)
 setBufferSize Set desired buffer size. The function will allocate memory accordingly. The frame size depends on the desired integration time, sampling frequency, and sample depth of the Sensor device (bps). You must set the frame size any time any of the prior parameters gets updated. More...
 
void setBPS (int bps)
 setBPP Set depth of Sensor device. More...
 
void setIntegrationTime (double duration)
 setIntegrationTime Set desired Sensor frame Integration duration for next Integration. You must call this function immediately before starting the actual Integration as it is used to calculate the timestamp used for the FITS header. More...
 
void setIntegrationLeft (double duration)
 setIntegrationLeft Update Integration time left. Inform the client of the new Integration time left value. More...
 
void setIntegrationFailed ()
 setIntegrationFailed Alert the client that the Integration failed. More...
 
int getNAxis () const
 
void setNAxis (int value)
 setNAxis Set FITS number of axis More...
 
void setIntegrationFileExtension (const char *ext)
 setIntegrationExtension Set integration exntension More...
 
char * getIntegrationFileExtension ()
 
bool isCapturing () const
 
virtual int SetTemperature (double temperature)
 Set Sensor temperature. More...
 
virtual bool StartStreaming ()
 StartStreaming Start live video streaming. More...
 
virtual bool StopStreaming ()
 StopStreaming Stop live video streaming. More...
 
virtual bool IntegrationComplete ()
 Uploads target Device exposed buffer as FITS to the client. Dervied classes should class this function when an Integration is complete. More...
 
virtual bool Handshake ()
 perform handshake with device to check communication More...
 
void setSensorConnection (const uint8_t &value)
 setSensorConnection Set Sensor connection mode. Child class should call this in the constructor before Sensor registers any connection interfaces More...
 
uint8_t getSensorConnection ()
 
virtual void addFITSKeywords (fitsfile *fptr, uint8_t *buf, int len)
 Add FITS keywords to a fits file. More...
 
void fits_update_key_s (fitsfile *fptr, int type, std::string name, void *p, std::string explanation, int *status)
 
- Public Member Functions inherited from INDI::DefaultDevice
 DefaultDevice ()
 
virtual ~DefaultDevice () override=default
 
void addAuxControls ()
 Add Debug, Simulation, and Configuration options to the driver. More...
 
void addDebugControl ()
 Add Debug control to the driver. More...
 
void addSimulationControl ()
 Add Simulation control to the driver. More...
 
void addConfigurationControl ()
 Add Configuration control to the driver. More...
 
void addPollPeriodControl ()
 Add Polling period control to the driver. More...
 
void resetProperties ()
 Set all properties to IDLE state. More...
 
void defineNumber (INumberVectorProperty *nvp) __attribute__((deprecated))
 Define number vector to client & register it. Alternatively, IDDefNumber can be used but the property will not get registered and the driver will not be able to save configuration files. More...
 
void defineProperty (INumberVectorProperty *property)
 
void defineText (ITextVectorProperty *tvp) __attribute__((deprecated))
 Define text vector to client & register it. Alternatively, IDDefText can be used but the property will not get registered and the driver will not be able to save configuration files. More...
 
void defineProperty (ITextVectorProperty *property)
 
void defineSwitch (ISwitchVectorProperty *svp) __attribute__((deprecated))
 Define switch vector to client & register it. Alternatively, IDDefswitch can be used but the property will not get registered and the driver will not be able to save configuration files. More...
 
void defineProperty (ISwitchVectorProperty *property)
 
void defineLight (ILightVectorProperty *lvp) __attribute__((deprecated))
 Define light vector to client & register it. Alternatively, IDDeflight can be used but the property will not get registered and the driver will not be able to save configuration files. More...
 
void defineProperty (ILightVectorProperty *property)
 
void defineBLOB (IBLOBVectorProperty *bvp) __attribute__((deprecated))
 Define BLOB vector to client & register it. Alternatively, IDDefBLOB can be used but the property will not get registered and the driver will not be able to save configuration files. More...
 
void defineProperty (IBLOBVectorProperty *property)
 
void defineProperty (INDI::Property &property)
 
virtual bool deleteProperty (const char *propertyName)
 Delete a property and unregister it. It will also be deleted from all clients. More...
 
virtual void setConnected (bool status, IPState state=IPS_OK, const char *msg=nullptr)
 Set connection switch status in the client. More...
 
int SetTimer (uint32_t ms)
 Set a timer to call the function TimerHit after ms milliseconds. More...
 
void RemoveTimer (int id)
 Remove timer added with SetTimer. More...
 
virtual void TimerHit ()
 Callback function to be called once SetTimer duration elapses. More...
 
virtual const char * getDriverExec ()
 
virtual const char * getDriverName ()
 
void setVersion (uint16_t vMajor, uint16_t vMinor)
 Set driver version information to be defined in DRIVER_INFO property as vMajor.vMinor. More...
 
uint16_t getMajorVersion () const
 
uint16_t getMinorVersion () const
 
virtual uint16_t getDriverInterface () override
 
void setDriverInterface (uint16_t value)
 setInterface Set driver interface. By default the driver interface is set to GENERAL_DEVICE. You may send an ORed list of DeviceInterface values. More...
 
- Public Member Functions inherited from INDI::BaseDevice
 BaseDevice ()
 
virtual ~BaseDevice ()
 
INDI::PropertyView< INumber > * getNumber (const char *name) const
 
INDI::PropertyView< IText > * getText (const char *name) const
 
INDI::PropertyView< ISwitch > * getSwitch (const char *name) const
 
INDI::PropertyView< ILight > * getLight (const char *name) const
 
INDI::PropertyView< IBLOB > * getBLOB (const char *name) const
 
IPState getPropertyState (const char *name) const
 
IPerm getPropertyPermission (const char *name) const
 
void registerProperty (void *p, INDI_PROPERTY_TYPE type)
 
void registerProperty (ITextVectorProperty *property)
 
void registerProperty (INumberVectorProperty *property)
 
void registerProperty (ISwitchVectorProperty *property)
 
void registerProperty (ILightVectorProperty *property)
 
void registerProperty (IBLOBVectorProperty *property)
 
void registerProperty (INDI::PropertyView< IText > *property)
 
void registerProperty (INDI::PropertyView< INumber > *property)
 
void registerProperty (INDI::PropertyView< ISwitch > *property)
 
void registerProperty (INDI::PropertyView< ILight > *property)
 
void registerProperty (INDI::PropertyView< IBLOB > *property)
 
void registerProperty (INDI::Property &property)
 
int removeProperty (const char *name, char *errmsg)
 Remove a property. More...
 
void * getRawProperty (const char *name, INDI_PROPERTY_TYPE type=INDI_UNKNOWN) const
 Return a property and its type given its name. More...
 
Property getProperty (const char *name, INDI_PROPERTY_TYPE type=INDI_UNKNOWN) const
 Return a property and its type given its name. More...
 
Properties getProperties ()
 Return a list of all properties in the device. More...
 
const Properties getProperties () const
 
void addMessage (const std::string &msg)
 Add message to the driver's message queue. More...
 
void checkMessage (XMLEle *root)
 
void doMessage (XMLEle *msg)
 
const std::string & messageQueue (size_t index) const
 
const std::string & lastMessage () const
 
bool isConnected () const
 
void setMediator (INDI::BaseMediator *mediator)
 Set the driver's mediator to receive notification of news devices and updated property values. More...
 
INDI::BaseMediatorgetMediator () const
 
void setDeviceName (const char *dev)
 Set the device name. More...
 
const char * getDeviceName () const
 
bool isDeviceNameMatch (const char *otherName) const
 Check that the device name matches the argument. More...
 
bool isDeviceNameMatch (const std::string &otherName) const
 Check that the device name matches the argument. More...
 
const char * getDriverName () const
 
const char * getDriverExec () const
 
const char * getDriverVersion () const
 
bool buildSkeleton (const char *filename)
 Build driver properties from a skeleton file. More...
 
int buildProp (XMLEle *root, char *errmsg, bool isDynamic=false)
 Build a property given the supplied XML element (defXXX) More...
 
int setValue (XMLEle *root, char *errmsg)
 handle SetXXX commands from client More...
 
int setBLOB (IBLOBVectorProperty *pp, XMLEle *root, char *errmsg)
 Parse and store BLOB in the respective vector. More...
 

Public Attributes

enum INDI::Correlator:: { ... }  CorrelatorCapability
 
INumberVectorProperty CorrelatorSettingsNP
 
- Public Attributes inherited from INDI::SensorInterface
enum INDI::SensorInterface:: { ... }  SensorCapability
 
enum INDI::SensorInterface:: { ... }  SensorConnection
 

Additional Inherited Members

- Protected Types inherited from INDI::SensorInterface
enum  { TELESCOPE_PRIMARY }
 
enum  { UPLOAD_DIR, UPLOAD_PREFIX }
 
enum  { FITS_OBSERVER, FITS_OBJECT }
 
- Protected Member Functions inherited from INDI::SensorInterface
bool HasShutter () const
 
bool HasCooler () const
 
bool CanAbort () const
 
bool HasDSP ()
 
bool HasStreaming ()
 
uint32_t GetCapability () const
 GetCapability returns the Sensor capabilities. More...
 
void SetCapability (uint32_t cap)
 SetCapability Set the Sensor capabilities. Al fields must be initilized. More...
 
virtual bool AbortIntegration ()
 Abort ongoing Integration. More...
 
virtual bool saveConfigItems (FILE *fp)
 saveConfigItems Save configuration items in XML file. More...
 
virtual void activeDevicesUpdated ()
 activeDevicesUpdated Inform children that ActiveDevices property was updated so they can snoop on the updated devices if desired. More...
 
- Protected Member Functions inherited from INDI::DefaultDevice
void setDynamicPropertiesBehavior (bool defineEnabled, bool deleteEnabled)
 setDynamicPropertiesBehavior controls handling of dynamic properties. Dyanmic properties are those generated from an external skeleton XML file. By default all properties, including dynamic properties, are defined to the client in ISGetProperties(). Furthermore, when ┼▒deleteProperty(properyName) is called, the dynamic property is deleted by default, and can only be restored by calling buildSkeleton(filename) again. However, it is sometimes desirable to skip the definition of the dynamic properties on startup and delegate this task to the child class. To control this behavior, set enabled to false. More...
 
virtual bool loadConfig (bool silent=false, const char *property=nullptr)
 Load the last saved configuration file. More...
 
virtual bool saveConfig (bool silent=false, const char *property=nullptr)
 Save the current properties in a configuration file. More...
 
virtual bool purgeConfig ()
 purgeConfig Remove config file from disk. More...
 
virtual bool saveAllConfigItems (FILE *fp)
 saveAllConfigItems Save all the drivers' properties in the configuration file More...
 
virtual bool loadDefaultConfig ()
 Load the default configuration file. More...
 
void setDebug (bool enable)
 Toggle driver debug status A driver can be more verbose if Debug option is enabled by the client. More...
 
void setSimulation (bool enable)
 Toggle driver simulation status A driver can run in simulation mode if Simulation option is enabled by the client. More...
 
virtual void debugTriggered (bool enable)
 Inform driver that the debug option was triggered. This function is called after setDebug is triggered by the client. Reimplement this function if your driver needs to take specific action after debug is enabled/disabled. Otherwise, you can use isDebug() to check if simulation is enabled or disabled. More...
 
virtual void simulationTriggered (bool enable)
 Inform driver that the simulation option was triggered. This function is called after setSimulation is triggered by the client. Reimplement this function if your driver needs to take specific action after simulation is enabled/disabled. Otherwise, you can use isSimulation() to check if simulation is enabled or disabled. More...
 
bool isDebug () const
 
bool isSimulation () const
 
virtual bool Connect ()
 Connect to the device. INDI::DefaultDevice implementation connects to appropriate connection interface (Serial or TCP) governed by connectionMode. If connection is successful, it proceed to call Handshake() function to ensure communication with device is successful. For other communication interface, override the method in the child class implementation. More...
 
virtual bool Disconnect ()
 Disconnect from device. More...
 
void registerConnection (Connection::Interface *newConnection)
 registerConnection Add new connection plugin to the existing connection pool. The connection type shall be defined to the client in ISGetProperties() More...
 
bool unRegisterConnection (Connection::Interface *existingConnection)
 unRegisterConnection Remove connection from existing pool More...
 
Connection::InterfacegetActiveConnection ()
 
void setActiveConnection (Connection::Interface *existingConnection)
 setActiveConnection Switch the active connection to the passed connection plugin More...
 
void setDefaultPollingPeriod (uint32_t msec)
 setDefaultPollingPeriod Change the default polling period to call TimerHit() function in the driver. More...
 
void setPollingPeriodRange (uint32_t minimum, uint32_t maximum)
 setPollingPeriodRange Set the range permitted by the polling range in milliseconds More...
 
uint32_t getPollingPeriod () const
 getPollingPeriod Return the polling period. More...
 
void setCurrentPollingPeriod (uint32_t msec)
 setCurrentPollingPeriod Change the current polling period to call TimerHit() function in the driver. More...
 
uint32_t getCurrentPollingPeriod () const
 getCurrentPollingPeriod Return the current polling period. More...
 
uint32_t & refCurrentPollingPeriod () __attribute__((deprecated))
 
uint32_t refCurrentPollingPeriod () const __attribute__((deprecated))
 
bool isConfigLoading () const
 isConfigLoading Check if driver configuration is currently in the process of getting loaded. More...
 
bool isInitializationComplete () const
 isInitializationComplete Check if driver initialization is complete. More...
 
void syncDriverInfo ()
 syncDriverInfo sends the current driver information to the client. More...
 
virtual const char * getDefaultName ()=0
 
 DefaultDevice (DefaultDevicePrivate &dd)
 
- Protected Member Functions inherited from INDI::BaseDevice
 BaseDevice (BaseDevicePrivate &dd)
 
- Protected Attributes inherited from INDI::SensorInterface
uint32_t capability
 
INumberVectorProperty FramedIntegrationNP
 
INumber FramedIntegrationN [1]
 
ISwitchVectorProperty AbortIntegrationSP
 
ISwitch AbortIntegrationS [1]
 
IBLOB FitsB
 
IBLOBVectorProperty FitsBP
 
ITextVectorProperty ActiveDeviceTP
 
IText ActiveDeviceT [4] {}
 
IText FileNameT [1] {}
 
ITextVectorProperty FileNameTP
 
ISwitch DatasetS [1]
 
ISwitchVectorProperty DatasetSP
 
ISwitch UploadS [3]
 
ISwitchVectorProperty UploadSP
 
IText UploadSettingsT [2] {}
 
ITextVectorProperty UploadSettingsTP
 
ISwitch TelescopeTypeS [2]
 
ISwitchVectorProperty TelescopeTypeSP
 
IText FITSHeaderT [2] {}
 
ITextVectorProperty FITSHeaderTP
 
bool InIntegration
 
INumberVectorProperty EqNP
 
INumber EqN [2]
 
double RA
 
double Dec
 
INumberVectorProperty LocationNP
 
INumber LocationN [3]
 
double Latitude
 
double Longitude
 
double Elevation
 
INumberVectorProperty ScopeParametersNP
 
INumber ScopeParametersN [4]
 
double primaryAperture
 
double primaryFocalLength
 
bool AutoLoop
 
bool SendIntegration
 
bool ShowMarker
 
double IntegrationTime
 
double MPSAS
 
INumber TemperatureN [1]
 
INumberVectorProperty TemperatureNP
 
std::mutex detectorBufferLock
 
std::unique_ptr< StreamManagerStreamer
 
std::unique_ptr< DSP::ManagerDSP
 
Connection::SerialserialConnection = NULL
 
Connection::TCPtcpConnection = NULL
 
int PortFD = -1
 For Serial & TCP connections. More...
 
- Protected Attributes inherited from INDI::BaseDevice
std::shared_ptr< BaseDevicePrivated_ptr
 

Detailed Description

Class to provide general functionality of Monodimensional Correlator.

The Correlator capabilities must be set to select which features are exposed to the clients. SetCorrelatorCapability() is typically set in the constructor or initProperties(), but can also be called after connection is established with the Correlator, but must be called /em before returning true in Connect().

Developers need to subclass INDI::Correlator to implement any driver for Correlators within INDI.

Definition at line 62 of file indicorrelator.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
CORRELATOR_MAX_CAPABILITY 

Can the Sensor Integration be aborted?

Definition at line 100 of file indicorrelator.h.

◆ CORRELATOR_INFO_INDEX

Enumerator
CORRELATOR_BASELINE_X 
CORRELATOR_BASELINE_Y 
CORRELATOR_BASELINE_Z 
CORRELATOR_WAVELENGTH 
CORRELATOR_BANDWIDTH 

Definition at line 252 of file indicorrelator.h.

Constructor & Destructor Documentation

◆ Correlator()

INDI::Correlator::Correlator ( )

Definition at line 61 of file indicorrelator.cpp.

◆ ~Correlator()

INDI::Correlator::~Correlator ( )
virtual

Definition at line 66 of file indicorrelator.cpp.

Member Function Documentation

◆ getBaseline()

Baseline INDI::Correlator::getBaseline ( )
inline

setBaseline Get the baseline size in meters.

Returns
the baseline size.

Definition at line 153 of file indicorrelator.h.

◆ getCorrelation()

Correlation INDI::Correlator::getCorrelation ( )
inline

getCorrelation Get current correlation degree plus UV and baseline information.

Returns
the correlation and UV coordinates.

Definition at line 129 of file indicorrelator.h.

◆ getCorrelationDegree()

virtual double INDI::Correlator::getCorrelationDegree ( )
inlinevirtual

getCorrelationDegree Get current correlation degree.

Returns
the correlation coefficient.

Definition at line 123 of file indicorrelator.h.

◆ GetCorrelatorCapability()

uint32_t INDI::Correlator::GetCorrelatorCapability ( ) const
inline

GetCorrelatorCapability returns the Sensor capabilities.

Definition at line 229 of file indicorrelator.h.

◆ getCorrelatorSettings()

INumberVectorProperty* INDI::Correlator::getCorrelatorSettings ( )
inline

Return Vector Info Property.

Definition at line 221 of file indicorrelator.h.

◆ getDelay() [1/3]

double INDI::Correlator::getDelay ( )

getDelay Get current baseline delay with reference to the current sidereal time.

Returns
the delay in meters.

Definition at line 197 of file indicorrelator.cpp.

◆ getDelay() [2/3]

double INDI::Correlator::getDelay ( double  alt,
double  az 
)

getUVCoordinates Get current baseline delay with reference to zenith/azimuth baseline.

Parameters
altaltitude of the target
azazimuth of the target
Returns
the delay in meters.

Definition at line 210 of file indicorrelator.cpp.

◆ getDelay() [3/3]

double INDI::Correlator::getDelay ( double  lst)

getUVCoordinates Get current baseline delay with reference to the given sidereal time.

Parameters
lstthe local sidereal time
Returns
the delay in meters.

Definition at line 204 of file indicorrelator.cpp.

◆ getUVCoordinates() [1/3]

Correlator::UVCoordinate INDI::Correlator::getUVCoordinates ( )

getUVCoordinates Get current UV projected coordinates with reference to the current sidereal time.

Returns
the UV coordinates.

Definition at line 173 of file indicorrelator.cpp.

◆ getUVCoordinates() [2/3]

Correlator::UVCoordinate INDI::Correlator::getUVCoordinates ( double  alt,
double  az 
)

getUVCoordinates Get current UV projected coordinates with reference to zenith/azimuth baseline.

Parameters
altaltitude of the target
azazimuth of the target
Returns
the UV coordinates.

Definition at line 190 of file indicorrelator.cpp.

◆ getUVCoordinates() [3/3]

Correlator::UVCoordinate INDI::Correlator::getUVCoordinates ( double  lst)

getUVCoordinates Get current UV projected coordinates with reference to the given sidereal time.

Parameters
lstthe local sidereal time
Returns
the UV coordinates.

Definition at line 182 of file indicorrelator.cpp.

◆ getWavelength()

double INDI::Correlator::getWavelength ( )
inline

setWavelength Get the observed wavelength.

Returns
the wavelength in meters.

Definition at line 162 of file indicorrelator.h.

◆ initProperties()

bool INDI::Correlator::initProperties ( )
overridevirtual

Initilize properties initial state and value. The child class must implement this function.

Returns
True if initilization is successful, false otherwise.

Reimplemented from INDI::DefaultDevice.

Definition at line 70 of file indicorrelator.cpp.

◆ ISGetProperties()

void INDI::Correlator::ISGetProperties ( const char *  dev)
overridevirtual

define the driver's properties to the client. Usually, only a minimum set of properties are defined to the client in this function if the device is in disconnected state. Those properties should be enough to enable the client to establish a connection to the device. In addition to CONNECT/DISCONNECT, such properties may include port name, IP address, etc. You should check if the device is already connected, and if this is true, then you must define the remainder of the the properties to the client in this function. Otherwise, the remainder of the driver's properties are defined to the client in updateProperties() function which is called when a client connects/disconnects from a device.

Parameters
devname of the device
Note
This function is called by the INDI framework, do not call it directly. See LX200 Generic driver for an example implementation

Reimplemented from INDI::DefaultDevice.

Definition at line 85 of file indicorrelator.cpp.

◆ ISNewBLOB()

bool INDI::Correlator::ISNewBLOB ( const char *  dev,
const char *  name,
int  sizes[],
int  blobsizes[],
char *  blobs[],
char *  formats[],
char *  names[],
int  n 
)
overridevirtual

Process the client newBLOB command.

Note
This function is called by the INDI framework, do not call it directly.
Returns
True if any property was successfully processed, false otherwise.

Reimplemented from INDI::DefaultDevice.

Definition at line 132 of file indicorrelator.cpp.

◆ ISNewNumber()

bool INDI::Correlator::ISNewNumber ( const char *  dev,
const char *  name,
double  values[],
char *  names[],
int  n 
)
overridevirtual

Process the client newNumber command.

Note
This function is called by the INDI framework, do not call it directly.
Returns
True if any property was successfully processed, false otherwise.

Reimplemented from INDI::DefaultDevice.

Definition at line 119 of file indicorrelator.cpp.

◆ ISNewSwitch()

bool INDI::Correlator::ISNewSwitch ( const char *  dev,
const char *  name,
ISState states,
char *  names[],
int  n 
)
overridevirtual

Process the client newSwitch command.

Note
This function is called by the INDI framework, do not call it directly.
Returns
True if any property was successfully processed, false otherwise.

Reimplemented from INDI::DefaultDevice.

Definition at line 127 of file indicorrelator.cpp.

◆ ISNewText()

bool INDI::Correlator::ISNewText ( const char *  dev,
const char *  name,
char *  texts[],
char *  names[],
int  n 
)
overridevirtual

Process the client newSwitch command.

Note
This function is called by the INDI framework, do not call it directly.
Returns
True if any property was successfully processed, false otherwise.

Reimplemented from INDI::DefaultDevice.

Definition at line 114 of file indicorrelator.cpp.

◆ ISSnoopDevice()

bool INDI::Correlator::ISSnoopDevice ( XMLEle root)
overridevirtual

Process a snoop event from INDI server. This function is called when a snooped property is updated in a snooped driver.

Note
This function is called by the INDI framework, do not call it directly.
Returns
True if any property was successfully processed, false otherwise.

Reimplemented from INDI::DefaultDevice.

Definition at line 109 of file indicorrelator.cpp.

◆ setBandwidth() [1/2]

double INDI::Correlator::setBandwidth ( )
inline

setBandwidth Get the bandwidth of the correlator.

Returns
the instrumentation bandwidth in Hz.

Definition at line 213 of file indicorrelator.h.

◆ setBandwidth() [2/2]

void INDI::Correlator::setBandwidth ( double  bw)

setBandwidth Set the bandwidth of the correlator.

Parameters
bandwidththe instrumentation bandwidth in Hz.

Definition at line 158 of file indicorrelator.cpp.

◆ setBaseline()

void INDI::Correlator::setBaseline ( Baseline  bl)

setBaseline Set the baseline size in meters.

Parameters
baselinethe baseline size.

Definition at line 138 of file indicorrelator.cpp.

◆ SetCorrelatorCapability()

void INDI::Correlator::SetCorrelatorCapability ( uint32_t  cap)

SetCorrelatorCapability Set the Correlator capabilities. Al fields must be initilized.

Parameters
cappointer to CorrelatorCapability struct.

Definition at line 167 of file indicorrelator.cpp.

◆ setMinMaxStep()

void INDI::Correlator::setMinMaxStep ( const char *  property,
const char *  element,
double  min,
double  max,
double  step,
bool  sendToClient 
)

setMinMaxStep for a number property element

Parameters
propertyProperty name
elementElement name
minMinimum element value
maxMaximum element value
stepElement step value
sendToClientIf true (default), the element limits are updated and is sent to the client. If false, the element limits are updated without getting sent to the client.

Definition at line 222 of file indicorrelator.cpp.

◆ setWavelength()

void INDI::Correlator::setWavelength ( double  wl)

setWavelength Set the observed wavelength.

Parameters
wavelengththe wavelength in meters.

Definition at line 149 of file indicorrelator.cpp.

◆ StartIntegration()

bool INDI::Correlator::StartIntegration ( double  duration)
overridevirtual

Start integration from the Sensor device.

Parameters
durationDuration in seconds
Returns
true if OK and Integration will take some time to complete, false on error.
Note
This function is not implemented in Sensor, it must be implemented in the child class

Reimplemented from INDI::SensorInterface.

Definition at line 215 of file indicorrelator.cpp.

◆ updateProperties()

bool INDI::Correlator::updateProperties ( )
overridevirtual

updateProperties is called whenever there is a change in the CONNECTION status of the driver. This will enable the driver to react to changes of switching ON/OFF a device. For example, a driver may only define a set of properties after a device is connected, but not before.

Returns
True if update is successful, false otherwise.

Reimplemented from INDI::DefaultDevice.

Definition at line 90 of file indicorrelator.cpp.

Member Data Documentation

◆ CorrelatorCapability

enum { ... } INDI::Correlator::CorrelatorCapability

◆ CorrelatorSettingsNP

INumberVectorProperty INDI::Correlator::CorrelatorSettingsNP

Definition at line 260 of file indicorrelator.h.


The documentation for this class was generated from the following files: