Instrument Neutral Distributed Interface INDI  1.7.6
Public Types | Public Member Functions | Public Attributes | Protected Types | Protected Member Functions | Protected Attributes | List of all members
INDI::Detector Class Reference

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

#include <indidetector.h>

Inheritance diagram for INDI::Detector:
INDI::DefaultDevice INDI::BaseDevice SimpleDetector

Public Types

enum  {
  DETECTOR_CAN_ABORT = 1 << 0, DETECTOR_HAS_SHUTTER = 1 << 1, DETECTOR_HAS_COOLER = 1 << 2, DETECTOR_HAS_CONTINUUM = 1 << 3,
  DETECTOR_HAS_SPECTRUM = 1 << 4, DETECTOR_HAS_TDEV = 1 << 5
}
 
- 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  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), AUX_INTERFACE = (1 << 15)
}
 The DRIVER_INTERFACE enum defines the class of devices the driver implements. A driver may implement one or more interfaces. More...
 

Public Member Functions

 Detector ()
 
virtual ~Detector ()
 
virtual bool initProperties ()
 Initilize properties initial state and value. The child class must implement this function. More...
 
virtual 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...
 
virtual void ISGetProperties (const char *dev)
 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...
 
virtual bool ISNewNumber (const char *dev, const char *name, double values[], char *names[], int n)
 Process the client newNumber command. More...
 
virtual bool ISNewSwitch (const char *dev, const char *name, ISState *states, char *names[], int n)
 Process the client newSwitch command. More...
 
virtual bool ISNewText (const char *dev, const char *name, char *texts[], char *names[], int n)
 Process the client newSwitch command. More...
 
virtual bool ISSnoopDevice (XMLEle *root)
 Process a snoop event from INDI server. This function is called when a snooped property is updated in a snooped driver. More...
 
- Public Member Functions inherited from INDI::DefaultDevice
 DefaultDevice ()
 
virtual ~DefaultDevice ()
 
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)
 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 defineText (ITextVectorProperty *tvp)
 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 defineSwitch (ISwitchVectorProperty *svp)
 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 defineLight (ILightVectorProperty *lvp)
 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 defineBLOB (IBLOBVectorProperty *bvp)
 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...
 
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 ()
 
uint16_t getMinorVersion ()
 
virtual bool ISNewBLOB (const char *dev, const char *name, int sizes[], int blobsizes[], char *blobs[], char *formats[], char *names[], int n)
 Process the client newBLOB command. More...
 
virtual uint16_t getDriverInterface ()
 
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 ()
 
INumberVectorPropertygetNumber (const char *name)
 
ITextVectorPropertygetText (const char *name)
 
ISwitchVectorPropertygetSwitch (const char *name)
 
ILightVectorPropertygetLight (const char *name)
 
IBLOBVectorPropertygetBLOB (const char *name)
 
IPState getPropertyState (const char *name)
 
IPerm getPropertyPermission (const char *name)
 
void registerProperty (void *p, INDI_PROPERTY_TYPE type)
 
int removeProperty (const char *name, char *errmsg)
 Remove a property. More...
 
void * getRawProperty (const char *name, INDI_PROPERTY_TYPE type=INDI_UNKNOWN)
 Return a property and its type given its name. More...
 
INDI::PropertygetProperty (const char *name, INDI_PROPERTY_TYPE type=INDI_UNKNOWN)
 Return a property and its type given its name. More...
 
std::vector< INDI::Property * > * getProperties ()
 Return a list of all properties in the device. More...
 
bool buildSkeleton (const char *filename)
 Build driver properties from a skeleton file. More...
 
bool isConnected ()
 
void setDeviceName (const char *dev)
 Set the device name. More...
 
const char * getDeviceName ()
 
void addMessage (const std::string &msg)
 Add message to the driver's message queue. More...
 
void checkMessage (XMLEle *root)
 
void doMessage (XMLEle *msg)
 
std::string messageQueue (int index) const
 
std::string lastMessage ()
 
void setMediator (INDI::BaseMediator *med)
 Set the driver's mediator to receive notification of news devices and updated property values. More...
 
INDI::BaseMediatorgetMediator ()
 
const char * getDriverName ()
 
const char * getDriverExec ()
 
const char * getDriverVersion ()
 

Public Attributes

enum INDI::Detector:: { ... }  DetectorCapability
 

Protected Types

enum  { UPLOAD_DIR, UPLOAD_PREFIX }
 
enum  { TELESCOPE_PRIMARY }
 
enum  { FITS_OBSERVER, FITS_OBJECT }
 

Protected Member Functions

uint32_t GetDetectorCapability () const
 GetDetectorCapability returns the Detector capabilities. More...
 
void SetDetectorCapability (uint32_t cap)
 SetDetectorCapability Set the Detector capabilities. Al fields must be initilized. More...
 
bool CanAbort ()
 
bool HasShutter ()
 
bool HasCooler ()
 
bool HasContinuum ()
 
bool HasSpectrum ()
 
bool HasTimeDeviation ()
 
virtual int SetTemperature (double temperature)
 Set Detector temperature. More...
 
virtual bool StartCapture (float duration)
 Start capture from the Detector device. More...
 
virtual bool CaptureParamsUpdated (float sr, float freq, float bps, float bw, float gain)
 Set common capture params. More...
 
virtual bool CaptureComplete (DetectorDevice *targetDevice)
 Uploads target Device exposed buffer as FITS to the client. Dervied classes should class this function when an Capture is complete. More...
 
virtual bool AbortCapture ()
 Abort ongoing Capture. More...
 
virtual void SetDetectorParams (float samplerate, float freq, float bps, float bw, float gain)
 Setup Detector parameters for the Detector. Child classes call this function to update Detector parameters. More...
 
void Histogram (void *buf, void *out, int buf_len, int histogram_size, int bits_per_sample)
 Create a histogram. More...
 
void FourierTransform (void *buf, void *out, int dims, int *sizes, int bits_per_sample)
 Create a Fourier transform. More...
 
void Spectrum (void *buf, void *out, int buf_len, int size, int bits_per_sample)
 Create a Spectrum. More...
 
void Convolution (void *buf, void *matrix, void *out, int dims, int *sizes, int matrix_dims, int *matrix_sizes, int bits_per_sample)
 Convolute. More...
 
virtual void addFITSKeywords (fitsfile *fptr, DetectorDevice *targetDevice, uint8_t *buf, int len)
 Add FITS keywords to a fits file. More...
 
void * sendFITS (DetectorDevice *targetDevice, int bIndex, uint8_t *buf, int len)
 
void fits_update_key_s (fitsfile *fptr, int type, std::string name, void *p, std::string explanation, int *status)
 
virtual void activeDevicesUpdated ()
 activeDevicesUpdated Inform children that ActiveDevices property was updated so they can snoop on the updated devices if desired. More...
 
virtual bool saveConfigItems (FILE *fp)
 saveConfigItems Save configuration items in XML file. 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 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 ()
 
bool isSimulation ()
 
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 setDefaultPollingPeriod (uint32_t period)
 
uint32_t getPollingPeriod ()
 
virtual const char * getDefaultName ()=0
 
- Protected Member Functions inherited from INDI::BaseDevice
int buildProp (XMLEle *root, char *errmsg)
 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...
 

Protected Attributes

double RA
 
double Dec
 
double primaryAperture
 
double primaryFocalLength
 
bool InCapture
 
bool AutoLoop
 
bool SendCapture
 
bool ShowMarker
 
float CaptureTime
 
double MPSAS
 
std::vector< std::string > FilterNames
 
int CurrentFilterSlot
 
DetectorDevice PrimaryDetector
 
INumberVectorProperty EqNP
 
INumber EqN [2]
 
ITextVectorProperty ActiveDeviceTP
 
IText ActiveDeviceT [4] {}
 
INumber TemperatureN [1]
 
INumberVectorProperty TemperatureNP
 
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
 
- Protected Attributes inherited from INDI::DefaultDevice
uint32_t POLLMS = 1000
 Period in milliseconds to call TimerHit(). Default 1000 ms. More...
 

Detailed Description

Class to provide general functionality of Monodimensional Detector.

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

Developers need to subclass INDI::Detector to implement any driver for Detectors within INDI.

Definition at line 409 of file indidetector.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
protected
Enumerator
FITS_OBSERVER 
FITS_OBJECT 

Definition at line 694 of file indidetector.h.

◆ anonymous enum

anonymous enum
Enumerator
DETECTOR_CAN_ABORT 

Can the Detector Capture be aborted?

DETECTOR_HAS_SHUTTER 

Does the Detector have a mechanical shutter?

DETECTOR_HAS_COOLER 

Does the Detector have a cooler and temperature control?

DETECTOR_HAS_CONTINUUM 

Does the Detector support live streaming?

DETECTOR_HAS_SPECTRUM 

Does the Detector support spectrum analysis?

DETECTOR_HAS_TDEV 

Does the Detector support time deviation correction?

Definition at line 415 of file indidetector.h.

◆ anonymous enum

anonymous enum
protected
Enumerator
UPLOAD_DIR 
UPLOAD_PREFIX 

Definition at line 678 of file indidetector.h.

◆ anonymous enum

anonymous enum
protected
Enumerator
TELESCOPE_PRIMARY 

Definition at line 686 of file indidetector.h.

Constructor & Destructor Documentation

◆ Detector()

INDI::Detector::Detector ( )

Definition at line 256 of file indidetector.cpp.

◆ ~Detector()

INDI::Detector::~Detector ( )
virtual

Definition at line 276 of file indidetector.cpp.

Member Function Documentation

◆ AbortCapture()

bool INDI::Detector::AbortCapture ( )
protectedvirtual

Abort ongoing Capture.

Returns
true is abort is successful, false otherwise.
Note
This function is not implemented in Detector, it must be implemented in the child class

Reimplemented in SimpleDetector.

Definition at line 727 of file indidetector.cpp.

◆ activeDevicesUpdated()

virtual void INDI::Detector::activeDevicesUpdated ( )
inlineprotectedvirtual

activeDevicesUpdated Inform children that ActiveDevices property was updated so they can snoop on the updated devices if desired.

Definition at line 629 of file indidetector.h.

◆ addFITSKeywords()

void INDI::Detector::addFITSKeywords ( fitsfile *  fptr,
DetectorDevice targetDevice,
uint8_t *  buf,
int  len 
)
protectedvirtual

Add FITS keywords to a fits file.

Parameters
fptrpointer to a valid FITS file.
targetDeviceThe target device to extract the keywords from.
blobIndexThe blob index of this FITS (0: continuum, 1: spectrum, 2: timedev).
Note
In additional to the standard FITS keywords, this function write the following keywords the FITS file:
  • EXPTIME: Total Capture Time (s)
  • DATAMIN: Minimum value
  • DATAMAX: Maximum value
  • INSTRUME: Detector Name
  • DATE-OBS: UTC start date of observation

To add additional information, override this function in the child class and ensure to call Detector::addFITSKeywords.

Definition at line 733 of file indidetector.cpp.

◆ CanAbort()

bool INDI::Detector::CanAbort ( )
inlineprotected
Returns
True if Detector can abort Capture. False otherwise.

Definition at line 451 of file indidetector.h.

◆ CaptureComplete()

bool INDI::Detector::CaptureComplete ( DetectorDevice targetDevice)
protectedvirtual

Uploads target Device exposed buffer as FITS to the client. Dervied classes should class this function when an Capture is complete.

Parameters
targetDevicedevice that contains upload capture data
Note
This function is not implemented in Detector, it must be implemented in the child class

Definition at line 969 of file indidetector.cpp.

◆ CaptureParamsUpdated()

bool INDI::Detector::CaptureParamsUpdated ( float  sr,
float  freq,
float  bps,
float  bw,
float  gain 
)
protectedvirtual

Set common capture params.

Parameters
srDetector samplerate (in Hz)
cfreqCapture frequency of the detector (Hz, observed frequency).
sfreqSampling frequency of the detector (Hz, electronic speed of the detector).
bpsBit resolution of a single sample.
bwBandwidth (Hz).
gainGain of the detector.
Returns
true if OK and Capture will take some time to complete, false on error.
Note
This function is not implemented in Detector, it must be implemented in the child class

Reimplemented in SimpleDetector.

Definition at line 716 of file indidetector.cpp.

◆ Convolution()

void INDI::Detector::Convolution ( void *  buf,
void *  matrix,
void *  out,
int  dims,
int *  sizes,
int  matrix_dims,
int *  matrix_sizes,
int  bits_per_sample 
)
protected

Convolute.

Parameters
bufthe buffer to convolute
matrixthe convolution matrix
outthe buffer where to copy the convoluted buffer
dimsthe number of dimensions of the input buffer
sizesthe sizes of each dimension of the input buffer
matrix_dimsthe number of dimensions of the matrix
matrix_sizesthe sizes of each dimension of the matrix
bits_per_samplecan be one of 8,16,32,64 for unsigned types, -32,-64 for floating single and double types

Definition at line 1466 of file indidetector.cpp.

◆ fits_update_key_s()

void INDI::Detector::fits_update_key_s ( fitsfile *  fptr,
int  type,
std::string  name,
void *  p,
std::string  explanation,
int *  status 
)
protected

A function to just remove GCC warnings about deprecated conversion

Definition at line 844 of file indidetector.cpp.

◆ FourierTransform()

void INDI::Detector::FourierTransform ( void *  buf,
void *  out,
int  dims,
int *  sizes,
int  bits_per_sample 
)
protected

Create a Fourier transform.

Parameters
bufthe buffer from which extract the Fourier transform
outthe buffer where to copy the Fourier transform
dimsthe number of dimensions of the input buffer
sizesthe sizes of each dimension
bits_per_samplecan be one of 8,16,32,64 for unsigned types, -32,-64 for floating single and double types

Definition at line 1399 of file indidetector.cpp.

◆ GetDetectorCapability()

uint32_t INDI::Detector::GetDetectorCapability ( ) const
inlineprotected

GetDetectorCapability returns the Detector capabilities.

Definition at line 437 of file indidetector.h.

◆ HasContinuum()

bool INDI::Detector::HasContinuum ( )
inlineprotected
Returns
True if the Detector supports live streaming. False otherwise.

Definition at line 475 of file indidetector.h.

◆ HasCooler()

bool INDI::Detector::HasCooler ( )
inlineprotected
Returns
True if Detector has cooler and temperature can be controlled. False otherwise.

Definition at line 467 of file indidetector.h.

◆ HasShutter()

bool INDI::Detector::HasShutter ( )
inlineprotected
Returns
True if Detector has mechanical or electronic shutter. False otherwise.

Definition at line 459 of file indidetector.h.

◆ HasSpectrum()

bool INDI::Detector::HasSpectrum ( )
inlineprotected
Returns
True if the Detector supports live streaming. False otherwise.

Definition at line 483 of file indidetector.h.

◆ HasTimeDeviation()

bool INDI::Detector::HasTimeDeviation ( )
inlineprotected
Returns
True if the Detector supports live streaming. False otherwise.

Definition at line 491 of file indidetector.h.

◆ Histogram()

void INDI::Detector::Histogram ( void *  buf,
void *  out,
int  buf_len,
int  histogram_size,
int  bits_per_sample 
)
protected

Create a histogram.

Parameters
bufthe buffer from which extract the histogram
outthe buffer where to copy the histogram
buf_lenthe length in bytes of the input buffer
histogram_sizethe size of the histogram
bits_per_samplecan be one of 8,16,32,64 for unsigned types, -32,-64 for floating single and double types

Definition at line 1338 of file indidetector.cpp.

◆ initProperties()

bool INDI::Detector::initProperties ( )
virtual

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.

Reimplemented in SimpleDetector.

Definition at line 287 of file indidetector.cpp.

◆ ISGetProperties()

void INDI::Detector::ISGetProperties ( const char *  dev)
virtual

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 399 of file indidetector.cpp.

◆ ISNewNumber()

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

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 567 of file indidetector.cpp.

◆ ISNewSwitch()

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

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 637 of file indidetector.cpp.

◆ ISNewText()

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

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 519 of file indidetector.cpp.

◆ ISSnoopDevice()

bool INDI::Detector::ISSnoopDevice ( XMLEle root)
virtual

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 456 of file indidetector.cpp.

◆ saveConfigItems()

bool INDI::Detector::saveConfigItems ( FILE *  fp)
protectedvirtual

saveConfigItems Save configuration items in XML file.

Parameters
fppointer to file to write to
Returns
True if successful, false otherwise

Reimplemented from INDI::DefaultDevice.

Definition at line 1140 of file indidetector.cpp.

◆ sendFITS()

void * INDI::Detector::sendFITS ( DetectorDevice targetDevice,
int  bIndex,
uint8_t *  buf,
int  len 
)
protected

Definition at line 851 of file indidetector.cpp.

◆ SetDetectorCapability()

void INDI::Detector::SetDetectorCapability ( uint32_t  cap)
protected

SetDetectorCapability Set the Detector capabilities. Al fields must be initilized.

Parameters
cappointer to DetectorCapability struct.

Definition at line 280 of file indidetector.cpp.

◆ SetDetectorParams()

void INDI::Detector::SetDetectorParams ( float  samplerate,
float  freq,
float  bps,
float  bw,
float  gain 
)
protectedvirtual

Setup Detector parameters for the Detector. Child classes call this function to update Detector parameters.

Parameters
samplerateDetector samplerate (in Hz)
freqCenter frequency of the detector (Hz, observed frequency).
bpsBit resolution of a single sample.
bwDetector bandwidth (in Hz).
gainDetector gain.

Definition at line 1130 of file indidetector.cpp.

◆ SetTemperature()

int INDI::Detector::SetTemperature ( double  temperature)
protectedvirtual

Set Detector temperature.

Parameters
temperatureDetector temperature in degrees celsius.
Returns
0 or 1 if setting the temperature call to the hardware is successful. -1 if an error is encountered. Return 0 if setting the temperature to the requested value takes time. Return 1 if setting the temperature to the requested value is complete.
Note
Upon returning 0, the property becomes BUSY. Once the temperature reaches the requested value, change the state to OK.
This function is not implemented in Detector, it must be implemented in the child class

Reimplemented in SimpleDetector.

Definition at line 702 of file indidetector.cpp.

◆ Spectrum()

void INDI::Detector::Spectrum ( void *  buf,
void *  out,
int  buf_len,
int  size,
int  bits_per_sample 
)
protected

Create a Spectrum.

Parameters
bufthe buffer from which extract the spectrum
outthe buffer where to copy the spectrum
buf_lenthe length in bytes of the input buffer
sizethe size of the spectrum
bits_per_samplecan be one of 8,16,32,64 for unsigned types, -32,-64 for floating single and double types

Definition at line 1331 of file indidetector.cpp.

◆ StartCapture()

bool INDI::Detector::StartCapture ( float  duration)
protectedvirtual

Start capture from the Detector device.

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

Reimplemented in SimpleDetector.

Definition at line 709 of file indidetector.cpp.

◆ updateProperties()

bool INDI::Detector::updateProperties ( )
virtual

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.

Reimplemented in SimpleDetector.

Definition at line 407 of file indidetector.cpp.

Member Data Documentation

◆ ActiveDeviceT

IText INDI::Detector::ActiveDeviceT[4] {}
protected

Definition at line 662 of file indidetector.h.

◆ ActiveDeviceTP

ITextVectorProperty INDI::Detector::ActiveDeviceTP
protected

Definition at line 661 of file indidetector.h.

◆ AutoLoop

bool INDI::Detector::AutoLoop
protected

Definition at line 643 of file indidetector.h.

◆ CaptureTime

float INDI::Detector::CaptureTime
protected

Definition at line 647 of file indidetector.h.

◆ CurrentFilterSlot

int INDI::Detector::CurrentFilterSlot
protected

Definition at line 653 of file indidetector.h.

◆ DatasetS

ISwitch INDI::Detector::DatasetS[1]
protected

Definition at line 670 of file indidetector.h.

◆ DatasetSP

ISwitchVectorProperty INDI::Detector::DatasetSP
protected

Definition at line 671 of file indidetector.h.

◆ Dec

double INDI::Detector::Dec
protected

Definition at line 638 of file indidetector.h.

◆ DetectorCapability

enum { ... } INDI::Detector::DetectorCapability

◆ EqN

INumber INDI::Detector::EqN[2]
protected

Definition at line 659 of file indidetector.h.

◆ EqNP

INumberVectorProperty INDI::Detector::EqNP
protected

Definition at line 658 of file indidetector.h.

◆ FileNameT

IText INDI::Detector::FileNameT[1] {}
protected

Definition at line 667 of file indidetector.h.

◆ FileNameTP

ITextVectorProperty INDI::Detector::FileNameTP
protected

Definition at line 668 of file indidetector.h.

◆ FilterNames

std::vector<std::string> INDI::Detector::FilterNames
protected

Definition at line 652 of file indidetector.h.

◆ FITSHeaderT

IText INDI::Detector::FITSHeaderT[2] {}
protected

Definition at line 692 of file indidetector.h.

◆ FITSHeaderTP

ITextVectorProperty INDI::Detector::FITSHeaderTP
protected

Definition at line 693 of file indidetector.h.

◆ InCapture

bool INDI::Detector::InCapture
protected

Definition at line 641 of file indidetector.h.

◆ MPSAS

double INDI::Detector::MPSAS
protected

Definition at line 650 of file indidetector.h.

◆ primaryAperture

double INDI::Detector::primaryAperture
protected

Definition at line 639 of file indidetector.h.

◆ PrimaryDetector

DetectorDevice INDI::Detector::PrimaryDetector
protected

Definition at line 655 of file indidetector.h.

◆ primaryFocalLength

double INDI::Detector::primaryFocalLength
protected

Definition at line 640 of file indidetector.h.

◆ RA

double INDI::Detector::RA
protected

Definition at line 638 of file indidetector.h.

◆ SendCapture

bool INDI::Detector::SendCapture
protected

Definition at line 644 of file indidetector.h.

◆ ShowMarker

bool INDI::Detector::ShowMarker
protected

Definition at line 645 of file indidetector.h.

◆ TelescopeTypeS

ISwitch INDI::Detector::TelescopeTypeS[2]
protected

Definition at line 684 of file indidetector.h.

◆ TelescopeTypeSP

ISwitchVectorProperty INDI::Detector::TelescopeTypeSP
protected

Definition at line 685 of file indidetector.h.

◆ TemperatureN

INumber INDI::Detector::TemperatureN[1]
protected

Definition at line 664 of file indidetector.h.

◆ TemperatureNP

INumberVectorProperty INDI::Detector::TemperatureNP
protected

Definition at line 665 of file indidetector.h.

◆ UploadS

ISwitch INDI::Detector::UploadS[3]
protected

Definition at line 673 of file indidetector.h.

◆ UploadSettingsT

IText INDI::Detector::UploadSettingsT[2] {}
protected

Definition at line 676 of file indidetector.h.

◆ UploadSettingsTP

ITextVectorProperty INDI::Detector::UploadSettingsTP
protected

Definition at line 677 of file indidetector.h.

◆ UploadSP

ISwitchVectorProperty INDI::Detector::UploadSP
protected

Definition at line 674 of file indidetector.h.


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