TwiceAsNice  2019-02-18
Public Types | Public Member Functions | Private Attributes | Friends | List of all members
INDI::CCDChip Class Reference

The CCDChip class provides functionality of a CCD Chip within a CCD. More...

#include <indiccd.h>

Collaboration diagram for INDI::CCDChip:
Collaboration graph

Public Types

enum  CCD_FRAME {
  LIGHT_FRAME = 0, BIAS_FRAME, DARK_FRAME, FLAT_FRAME,
  LIGHT_FRAME = 0, BIAS_FRAME, DARK_FRAME, FLAT_FRAME
}
 
enum  CCD_FRAME_INDEX {
  FRAME_X, FRAME_Y, FRAME_W, FRAME_H,
  FRAME_X, FRAME_Y, FRAME_W, FRAME_H
}
 
enum  CCD_BIN_INDEX { BIN_W, BIN_H, BIN_W, BIN_H }
 
enum  CCD_INFO_INDEX {
  CCD_MAX_X, CCD_MAX_Y, CCD_PIXEL_SIZE, CCD_PIXEL_SIZE_X,
  CCD_PIXEL_SIZE_Y, CCD_BITSPERPIXEL, CCD_MAX_X, CCD_MAX_Y,
  CCD_PIXEL_SIZE, CCD_PIXEL_SIZE_X, CCD_PIXEL_SIZE_Y, CCD_BITSPERPIXEL
}
 
enum  CCD_FRAME {
  LIGHT_FRAME = 0, BIAS_FRAME, DARK_FRAME, FLAT_FRAME,
  LIGHT_FRAME = 0, BIAS_FRAME, DARK_FRAME, FLAT_FRAME
}
 
enum  CCD_FRAME_INDEX {
  FRAME_X, FRAME_Y, FRAME_W, FRAME_H,
  FRAME_X, FRAME_Y, FRAME_W, FRAME_H
}
 
enum  CCD_BIN_INDEX { BIN_W, BIN_H, BIN_W, BIN_H }
 
enum  CCD_INFO_INDEX {
  CCD_MAX_X, CCD_MAX_Y, CCD_PIXEL_SIZE, CCD_PIXEL_SIZE_X,
  CCD_PIXEL_SIZE_Y, CCD_BITSPERPIXEL, CCD_MAX_X, CCD_MAX_Y,
  CCD_PIXEL_SIZE, CCD_PIXEL_SIZE_X, CCD_PIXEL_SIZE_Y, CCD_BITSPERPIXEL
}
 

Public Member Functions

 CCDChip ()
 
 ~CCDChip ()
 
int getXRes ()
 getXRes Get the horizontal resolution in pixels of the CCD Chip. More...
 
int getYRes ()
 Get the vertical resolution in pixels of the CCD Chip. More...
 
int getSubX ()
 getSubX Get the starting left coordinates (X) of the frame. More...
 
int getSubY ()
 getSubY Get the starting top coordinates (Y) of the frame. More...
 
int getSubW ()
 getSubW Get the width of the frame More...
 
int getSubH ()
 getSubH Get the height of the frame More...
 
int getBinX ()
 getBinX Get horizontal binning of the CCD chip. More...
 
int getBinY ()
 getBinY Get vertical binning of the CCD chip. More...
 
float getPixelSizeX ()
 getPixelSizeX Get horizontal pixel size in microns. More...
 
float getPixelSizeY ()
 getPixelSizeY Get vertical pixel size in microns. More...
 
int getBPP ()
 getBPP Get CCD Chip depth (bits per pixel). More...
 
int getFrameBufferSize ()
 getFrameBufferSize Get allocated frame buffer size to hold the CCD image frame. More...
 
double getExposureLeft ()
 getExposureLeft Get exposure time left in seconds. More...
 
double getExposureDuration ()
 getExposureDuration Get requested exposure duration for the CCD chip in seconds. More...
 
const char * getExposureStartTime ()
 getExposureStartTime More...
 
uint8_tgetFrameBuffer ()
 getFrameBuffer Get raw frame buffer of the CCD chip. More...
 
void setFrameBuffer (uint8_t *buffer)
 setFrameBuffer Set raw frame buffer pointer. More...
 
bool isCompressed ()
 isCompressed More...
 
bool isInterlaced ()
 isInterlaced More...
 
CCD_FRAME getFrameType ()
 getFrameType More...
 
const char * getFrameTypeName (CCD_FRAME fType)
 getFrameTypeName returns CCD Frame type name More...
 
INumberVectorPropertygetCCDInfo ()
 Return CCD Info Property. More...
 
void setResolution (int x, int y)
 setResolution set CCD Chip resolution More...
 
void setFrame (int subx, int suby, int subw, int subh)
 setFrame Set desired frame resolutoin for an exposure. More...
 
void setBin (int hor, int ver)
 setBin Set CCD Chip binnig 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 setPixelSize (float x, float y)
 setPixelSize Set CCD Chip pixel size More...
 
void setCompressed (bool cmp)
 setCompressed Set whether a frame is compressed after exposure? More...
 
void setInterlaced (bool intr)
 setInterlaced Set whether the CCD chip is interlaced or not? More...
 
void setFrameBufferSize (int nbuf, bool allocMem=true)
 setFrameBufferSize Set desired frame buffer size. More...
 
void setBPP (int bpp)
 setBPP Set depth of CCD chip. More...
 
void setFrameType (CCD_FRAME type)
 setFrameType Set desired frame type for next exposure. More...
 
void setExposureDuration (double duration)
 setExposureDuration Set desired CCD frame exposure duration for next exposure. More...
 
void setExposureLeft (double duration)
 setExposureLeft Update exposure time left. More...
 
void setExposureFailed ()
 setExposureFailed Alert the client that the exposure failed. More...
 
int getNAxis () const
 
void setNAxis (int value)
 setNAxis Set FITS number of axis More...
 
void setImageExtension (const char *ext)
 setImageExtension Set image exntension More...
 
char * getImageExtension ()
 
bool isExposing ()
 
void binFrame ()
 binFrame Perform softwre binning on the CCD frame. More...
 
 CCDChip ()
 
 ~CCDChip ()
 
int getXRes ()
 getXRes Get the horizontal resolution in pixels of the CCD Chip. More...
 
int getYRes ()
 Get the vertical resolution in pixels of the CCD Chip. More...
 
int getSubX ()
 getSubX Get the starting left coordinates (X) of the frame. More...
 
int getSubY ()
 getSubY Get the starting top coordinates (Y) of the frame. More...
 
int getSubW ()
 getSubW Get the width of the frame More...
 
int getSubH ()
 getSubH Get the height of the frame More...
 
int getBinX ()
 getBinX Get horizontal binning of the CCD chip. More...
 
int getBinY ()
 getBinY Get vertical binning of the CCD chip. More...
 
float getPixelSizeX ()
 getPixelSizeX Get horizontal pixel size in microns. More...
 
float getPixelSizeY ()
 getPixelSizeY Get vertical pixel size in microns. More...
 
int getBPP ()
 getBPP Get CCD Chip depth (bits per pixel). More...
 
int getFrameBufferSize ()
 getFrameBufferSize Get allocated frame buffer size to hold the CCD image frame. More...
 
double getExposureLeft ()
 getExposureLeft Get exposure time left in seconds. More...
 
double getExposureDuration ()
 getExposureDuration Get requested exposure duration for the CCD chip in seconds. More...
 
const char * getExposureStartTime ()
 getExposureStartTime More...
 
uint8_tgetFrameBuffer ()
 getFrameBuffer Get raw frame buffer of the CCD chip. More...
 
void setFrameBuffer (uint8_t *buffer)
 setFrameBuffer Set raw frame buffer pointer. More...
 
bool isCompressed ()
 isCompressed More...
 
bool isInterlaced ()
 isInterlaced More...
 
CCD_FRAME getFrameType ()
 getFrameType More...
 
const char * getFrameTypeName (CCD_FRAME fType)
 getFrameTypeName returns CCD Frame type name More...
 
INumberVectorPropertygetCCDInfo ()
 Return CCD Info Property. More...
 
void setResolution (int x, int y)
 setResolution set CCD Chip resolution More...
 
void setFrame (int subx, int suby, int subw, int subh)
 setFrame Set desired frame resolutoin for an exposure. More...
 
void setBin (int hor, int ver)
 setBin Set CCD Chip binnig 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 setPixelSize (float x, float y)
 setPixelSize Set CCD Chip pixel size More...
 
void setCompressed (bool cmp)
 setCompressed Set whether a frame is compressed after exposure? More...
 
void setInterlaced (bool intr)
 setInterlaced Set whether the CCD chip is interlaced or not? More...
 
void setFrameBufferSize (int nbuf, bool allocMem=true)
 setFrameBufferSize Set desired frame buffer size. More...
 
void setBPP (int bpp)
 setBPP Set depth of CCD chip. More...
 
void setFrameType (CCD_FRAME type)
 setFrameType Set desired frame type for next exposure. More...
 
void setExposureDuration (double duration)
 setExposureDuration Set desired CCD frame exposure duration for next exposure. More...
 
void setExposureLeft (double duration)
 setExposureLeft Update exposure time left. More...
 
void setExposureFailed ()
 setExposureFailed Alert the client that the exposure failed. More...
 
int getNAxis () const
 
void setNAxis (int value)
 setNAxis Set FITS number of axis More...
 
void setImageExtension (const char *ext)
 setImageExtension Set image exntension More...
 
char * getImageExtension ()
 
bool isExposing ()
 
void binFrame ()
 binFrame Perform softwre binning on the CCD frame. More...
 

Private Attributes

int XRes
 Native x resolution of the ccd. More...
 
int YRes
 Native y resolution of the ccd. More...
 
int SubX
 Left side of the subframe we are requesting. More...
 
int SubY
 Top of the subframe requested. More...
 
int SubW
 UNBINNED width of the subframe. More...
 
int SubH
 UNBINNED height of the subframe. More...
 
int BinX
 Binning requested in the x direction. More...
 
int BinY
 Binning requested in the y direction. More...
 
int NAxis
 

of Axis

More...
 
float PixelSizex
 Pixel size in microns, x direction. More...
 
float PixelSizey
 Pixel size in microns, y direction. More...
 
int BPP
 Bytes per Pixel. More...
 
bool Interlaced = false
 
uint8_tRawFrame = nullptr
 
uint8_tBinFrame = nullptr
 
int RawFrameSize = 0
 
bool SendCompressed = false
 
CCD_FRAME FrameType
 
double exposureDuration
 
timeval startExposureTime
 
int lastRapidX
 
int lastRapidY
 
char imageExtention [MAXINDIBLOBFMT]
 
INumberVectorProperty ImageExposureNP
 
INumber ImageExposureN [1]
 
ISwitchVectorProperty AbortExposureSP
 
ISwitch AbortExposureS [1]
 
INumberVectorProperty ImageFrameNP
 
INumber ImageFrameN [4]
 
INumberVectorProperty ImageBinNP
 
INumber ImageBinN [2]
 
INumberVectorProperty ImagePixelSizeNP
 
INumber ImagePixelSizeN [6]
 
ISwitch FrameTypeS [5]
 
ISwitchVectorProperty FrameTypeSP
 
ISwitch CompressS [2]
 
ISwitchVectorProperty CompressSP
 
IBLOB FitsB
 
IBLOBVectorProperty FitsBP
 
ISwitch RapidGuideS [2]
 
ISwitchVectorProperty RapidGuideSP
 
ISwitch RapidGuideSetupS [3]
 
ISwitchVectorProperty RapidGuideSetupSP
 
INumber RapidGuideDataN [3]
 
INumberVectorProperty RapidGuideDataNP
 
ISwitch ResetS [1]
 
ISwitchVectorProperty ResetSP
 

Friends

class CCD
 
class StreamRecoder
 

Detailed Description

The CCDChip class provides functionality of a CCD Chip within a CCD.

Member Enumeration Documentation

◆ CCD_BIN_INDEX [1/2]

Enumerator
BIN_W 
BIN_H 
BIN_W 
BIN_H 

◆ CCD_BIN_INDEX [2/2]

Enumerator
BIN_W 
BIN_H 
BIN_W 
BIN_H 

◆ CCD_FRAME [1/2]

Enumerator
LIGHT_FRAME 
BIAS_FRAME 
DARK_FRAME 
FLAT_FRAME 
LIGHT_FRAME 
BIAS_FRAME 
DARK_FRAME 
FLAT_FRAME 

◆ CCD_FRAME [2/2]

Enumerator
LIGHT_FRAME 
BIAS_FRAME 
DARK_FRAME 
FLAT_FRAME 
LIGHT_FRAME 
BIAS_FRAME 
DARK_FRAME 
FLAT_FRAME 

◆ CCD_FRAME_INDEX [1/2]

Enumerator
FRAME_X 
FRAME_Y 
FRAME_W 
FRAME_H 
FRAME_X 
FRAME_Y 
FRAME_W 
FRAME_H 

◆ CCD_FRAME_INDEX [2/2]

Enumerator
FRAME_X 
FRAME_Y 
FRAME_W 
FRAME_H 
FRAME_X 
FRAME_Y 
FRAME_W 
FRAME_H 

◆ CCD_INFO_INDEX [1/2]

Enumerator
CCD_MAX_X 
CCD_MAX_Y 
CCD_PIXEL_SIZE 
CCD_PIXEL_SIZE_X 
CCD_PIXEL_SIZE_Y 
CCD_BITSPERPIXEL 
CCD_MAX_X 
CCD_MAX_Y 
CCD_PIXEL_SIZE 
CCD_PIXEL_SIZE_X 
CCD_PIXEL_SIZE_Y 
CCD_BITSPERPIXEL 

◆ CCD_INFO_INDEX [2/2]

Enumerator
CCD_MAX_X 
CCD_MAX_Y 
CCD_PIXEL_SIZE 
CCD_PIXEL_SIZE_X 
CCD_PIXEL_SIZE_Y 
CCD_BITSPERPIXEL 
CCD_MAX_X 
CCD_MAX_Y 
CCD_PIXEL_SIZE 
CCD_PIXEL_SIZE_X 
CCD_PIXEL_SIZE_Y 
CCD_BITSPERPIXEL 

Constructor & Destructor Documentation

◆ CCDChip() [1/2]

INDI::CCDChip::CCDChip ( )

◆ ~CCDChip() [1/2]

INDI::CCDChip::~CCDChip ( )

◆ CCDChip() [2/2]

INDI::CCDChip::CCDChip ( )

◆ ~CCDChip() [2/2]

INDI::CCDChip::~CCDChip ( )

Member Function Documentation

◆ binFrame() [1/2]

void INDI::CCDChip::binFrame ( )

binFrame Perform softwre binning on the CCD frame.

Only use this function if hardware binning is not supported.

◆ binFrame() [2/2]

void INDI::CCDChip::binFrame ( )

binFrame Perform softwre binning on the CCD frame.

Only use this function if hardware binning is not supported.

◆ getBinX() [1/2]

int INDI::CCDChip::getBinX ( )
inline

getBinX Get horizontal binning of the CCD chip.

Returns
horizontal binning of the CCD chip.

◆ getBinX() [2/2]

int INDI::CCDChip::getBinX ( )
inline

getBinX Get horizontal binning of the CCD chip.

Returns
horizontal binning of the CCD chip.

◆ getBinY() [1/2]

int INDI::CCDChip::getBinY ( )
inline

getBinY Get vertical binning of the CCD chip.

Returns
vertical binning of the CCD chip.

◆ getBinY() [2/2]

int INDI::CCDChip::getBinY ( )
inline

getBinY Get vertical binning of the CCD chip.

Returns
vertical binning of the CCD chip.

◆ getBPP() [1/2]

int INDI::CCDChip::getBPP ( )
inline

getBPP Get CCD Chip depth (bits per pixel).

Returns
bits per pixel.

◆ getBPP() [2/2]

int INDI::CCDChip::getBPP ( )
inline

getBPP Get CCD Chip depth (bits per pixel).

Returns
bits per pixel.

◆ getCCDInfo() [1/2]

INumberVectorProperty* INDI::CCDChip::getCCDInfo ( )
inline

Return CCD Info Property.

◆ getCCDInfo() [2/2]

INumberVectorProperty* INDI::CCDChip::getCCDInfo ( )
inline

Return CCD Info Property.

◆ getExposureDuration() [1/2]

double INDI::CCDChip::getExposureDuration ( )
inline

getExposureDuration Get requested exposure duration for the CCD chip in seconds.

Returns
requested exposure duration for the CCD chip in seconds.

◆ getExposureDuration() [2/2]

double INDI::CCDChip::getExposureDuration ( )
inline

getExposureDuration Get requested exposure duration for the CCD chip in seconds.

Returns
requested exposure duration for the CCD chip in seconds.

◆ getExposureLeft() [1/2]

double INDI::CCDChip::getExposureLeft ( )
inline

getExposureLeft Get exposure time left in seconds.

Returns
exposure time left in seconds.

◆ getExposureLeft() [2/2]

double INDI::CCDChip::getExposureLeft ( )
inline

getExposureLeft Get exposure time left in seconds.

Returns
exposure time left in seconds.

◆ getExposureStartTime() [1/2]

const char* INDI::CCDChip::getExposureStartTime ( )

getExposureStartTime

Returns
exposure start time in ISO 8601 format.

◆ getExposureStartTime() [2/2]

const char * INDI::CCDChip::getExposureStartTime ( )

getExposureStartTime

Returns
exposure start time in ISO 8601 format.

◆ getFrameBuffer() [1/2]

uint8_t* INDI::CCDChip::getFrameBuffer ( )
inline

getFrameBuffer Get raw frame buffer of the CCD chip.

Returns
raw frame buffer of the CCD chip.

◆ getFrameBuffer() [2/2]

uint8_t* INDI::CCDChip::getFrameBuffer ( )
inline

getFrameBuffer Get raw frame buffer of the CCD chip.

Returns
raw frame buffer of the CCD chip.

◆ getFrameBufferSize() [1/2]

int INDI::CCDChip::getFrameBufferSize ( )
inline

getFrameBufferSize Get allocated frame buffer size to hold the CCD image frame.

Returns
allocated frame buffer size to hold the CCD image frame.

◆ getFrameBufferSize() [2/2]

int INDI::CCDChip::getFrameBufferSize ( )
inline

getFrameBufferSize Get allocated frame buffer size to hold the CCD image frame.

Returns
allocated frame buffer size to hold the CCD image frame.

◆ getFrameType() [1/2]

CCD_FRAME INDI::CCDChip::getFrameType ( )
inline

getFrameType

Returns
CCD Frame type

◆ getFrameType() [2/2]

CCD_FRAME INDI::CCDChip::getFrameType ( )
inline

getFrameType

Returns
CCD Frame type

◆ getFrameTypeName() [1/2]

const char * INDI::CCDChip::getFrameTypeName ( CCD_FRAME  fType)

getFrameTypeName returns CCD Frame type name

Parameters
fTypetype of frame
Returns
CCD Frame type name

◆ getFrameTypeName() [2/2]

const char* INDI::CCDChip::getFrameTypeName ( CCD_FRAME  fType)

getFrameTypeName returns CCD Frame type name

Parameters
fTypetype of frame
Returns
CCD Frame type name

◆ getImageExtension() [1/2]

char* INDI::CCDChip::getImageExtension ( )
inline
Returns
Return image extension (fits, jpeg, raw..etc)

◆ getImageExtension() [2/2]

char* INDI::CCDChip::getImageExtension ( )
inline
Returns
Return image extension (fits, jpeg, raw..etc)

◆ getNAxis() [1/2]

int INDI::CCDChip::getNAxis ( ) const
Returns
Get number of FITS axis in image. By default 2

◆ getNAxis() [2/2]

int INDI::CCDChip::getNAxis ( ) const
Returns
Get number of FITS axis in image. By default 2

◆ getPixelSizeX() [1/2]

float INDI::CCDChip::getPixelSizeX ( )
inline

getPixelSizeX Get horizontal pixel size in microns.

Returns
horizontal pixel size in microns.

◆ getPixelSizeX() [2/2]

float INDI::CCDChip::getPixelSizeX ( )
inline

getPixelSizeX Get horizontal pixel size in microns.

Returns
horizontal pixel size in microns.

◆ getPixelSizeY() [1/2]

float INDI::CCDChip::getPixelSizeY ( )
inline

getPixelSizeY Get vertical pixel size in microns.

Returns
vertical pixel size in microns.

◆ getPixelSizeY() [2/2]

float INDI::CCDChip::getPixelSizeY ( )
inline

getPixelSizeY Get vertical pixel size in microns.

Returns
vertical pixel size in microns.

◆ getSubH() [1/2]

int INDI::CCDChip::getSubH ( )
inline

getSubH Get the height of the frame

Returns
unbinned height of the frame

◆ getSubH() [2/2]

int INDI::CCDChip::getSubH ( )
inline

getSubH Get the height of the frame

Returns
unbinned height of the frame

◆ getSubW() [1/2]

int INDI::CCDChip::getSubW ( )
inline

getSubW Get the width of the frame

Returns
unbinned width of the frame

◆ getSubW() [2/2]

int INDI::CCDChip::getSubW ( )
inline

getSubW Get the width of the frame

Returns
unbinned width of the frame

◆ getSubX() [1/2]

int INDI::CCDChip::getSubX ( )
inline

getSubX Get the starting left coordinates (X) of the frame.

Returns
the starting left coordinates (X) of the image.

◆ getSubX() [2/2]

int INDI::CCDChip::getSubX ( )
inline

getSubX Get the starting left coordinates (X) of the frame.

Returns
the starting left coordinates (X) of the image.

◆ getSubY() [1/2]

int INDI::CCDChip::getSubY ( )
inline

getSubY Get the starting top coordinates (Y) of the frame.

Returns
the starting top coordinates (Y) of the image.

◆ getSubY() [2/2]

int INDI::CCDChip::getSubY ( )
inline

getSubY Get the starting top coordinates (Y) of the frame.

Returns
the starting top coordinates (Y) of the image.

◆ getXRes() [1/2]

int INDI::CCDChip::getXRes ( )
inline

getXRes Get the horizontal resolution in pixels of the CCD Chip.

Returns
the horizontal resolution of the CCD Chip.

◆ getXRes() [2/2]

int INDI::CCDChip::getXRes ( )
inline

getXRes Get the horizontal resolution in pixels of the CCD Chip.

Returns
the horizontal resolution of the CCD Chip.

◆ getYRes() [1/2]

int INDI::CCDChip::getYRes ( )
inline

Get the vertical resolution in pixels of the CCD Chip.

Returns
the horizontal resolution of the CCD Chip.

◆ getYRes() [2/2]

int INDI::CCDChip::getYRes ( )
inline

Get the vertical resolution in pixels of the CCD Chip.

Returns
the horizontal resolution of the CCD Chip.

◆ isCompressed() [1/2]

bool INDI::CCDChip::isCompressed ( )
inline

isCompressed

Returns
True if frame is compressed, false otherwise.

◆ isCompressed() [2/2]

bool INDI::CCDChip::isCompressed ( )
inline

isCompressed

Returns
True if frame is compressed, false otherwise.

◆ isExposing() [1/2]

bool INDI::CCDChip::isExposing ( )
inline
Returns
True if CCD is currently exposing, false otherwise.

◆ isExposing() [2/2]

bool INDI::CCDChip::isExposing ( )
inline
Returns
True if CCD is currently exposing, false otherwise.

◆ isInterlaced() [1/2]

bool INDI::CCDChip::isInterlaced ( )
inline

isInterlaced

Returns
True if CCD chip is Interlaced, false otherwise.

◆ isInterlaced() [2/2]

bool INDI::CCDChip::isInterlaced ( )
inline

isInterlaced

Returns
True if CCD chip is Interlaced, false otherwise.

◆ setBin() [1/2]

void INDI::CCDChip::setBin ( int  hor,
int  ver 
)

setBin Set CCD Chip binnig

Parameters
horHorizontal binning.
verVertical binning.

◆ setBin() [2/2]

void INDI::CCDChip::setBin ( int  hor,
int  ver 
)

setBin Set CCD Chip binnig

Parameters
horHorizontal binning.
verVertical binning.

◆ setBPP() [1/2]

void INDI::CCDChip::setBPP ( int  bpp)

setBPP Set depth of CCD chip.

Parameters
bppbits per pixel

◆ setBPP() [2/2]

void INDI::CCDChip::setBPP ( int  bpp)

setBPP Set depth of CCD chip.

Parameters
bppbits per pixel

◆ setCompressed() [1/2]

void INDI::CCDChip::setCompressed ( bool  cmp)

setCompressed Set whether a frame is compressed after exposure?

Parameters
cmpIf true, compress frame.

◆ setCompressed() [2/2]

void INDI::CCDChip::setCompressed ( bool  cmp)

setCompressed Set whether a frame is compressed after exposure?

Parameters
cmpIf true, compress frame.

◆ setExposureDuration() [1/2]

void INDI::CCDChip::setExposureDuration ( double  duration)

setExposureDuration Set desired CCD frame exposure duration for next exposure.

You must call this function immediately before starting the actual exposure as it is used to calculate the timestamp used for the FITS header.

Parameters
durationexposure duration in seconds.

◆ setExposureDuration() [2/2]

void INDI::CCDChip::setExposureDuration ( double  duration)

setExposureDuration Set desired CCD frame exposure duration for next exposure.

You must call this function immediately before starting the actual exposure as it is used to calculate the timestamp used for the FITS header.

Parameters
durationexposure duration in seconds.

◆ setExposureFailed() [1/2]

void INDI::CCDChip::setExposureFailed ( )

setExposureFailed Alert the client that the exposure failed.

◆ setExposureFailed() [2/2]

void INDI::CCDChip::setExposureFailed ( )

setExposureFailed Alert the client that the exposure failed.

◆ setExposureLeft() [1/2]

void INDI::CCDChip::setExposureLeft ( double  duration)

setExposureLeft Update exposure time left.

Inform the client of the new exposure time left value.

Parameters
durationexposure duration left in seconds.

◆ setExposureLeft() [2/2]

void INDI::CCDChip::setExposureLeft ( double  duration)

setExposureLeft Update exposure time left.

Inform the client of the new exposure time left value.

Parameters
durationexposure duration left in seconds.

◆ setFrame() [1/2]

void INDI::CCDChip::setFrame ( int  subx,
int  suby,
int  subw,
int  subh 
)

setFrame Set desired frame resolutoin for an exposure.

Parameters
subxLeft position.
subyTop position.
subwunbinned width of the frame.
subhunbinned height of the frame.

◆ setFrame() [2/2]

void INDI::CCDChip::setFrame ( int  subx,
int  suby,
int  subw,
int  subh 
)

setFrame Set desired frame resolutoin for an exposure.

Parameters
subxLeft position.
subyTop position.
subwunbinned width of the frame.
subhunbinned height of the frame.

◆ setFrameBuffer() [1/2]

void INDI::CCDChip::setFrameBuffer ( uint8_t buffer)
inline

setFrameBuffer Set raw frame buffer pointer.

Parameters
bufferpointer to frame buffer /note CCD Chip allocates the frame buffer internally once SetFrameBufferSize is called with allocMem set to true which is the default behavior. If you allocated the memory yourself (i.e. allocMem is false), then you must call this function to set the pointer to the raw frame buffer.

◆ setFrameBuffer() [2/2]

void INDI::CCDChip::setFrameBuffer ( uint8_t buffer)
inline

setFrameBuffer Set raw frame buffer pointer.

Parameters
bufferpointer to frame buffer /note CCD Chip allocates the frame buffer internally once SetFrameBufferSize is called with allocMem set to true which is the default behavior. If you allocated the memory yourself (i.e. allocMem is false), then you must call this function to set the pointer to the raw frame buffer.

◆ setFrameBufferSize() [1/2]

void INDI::CCDChip::setFrameBufferSize ( int  nbuf,
bool  allocMem = true 
)

setFrameBufferSize Set desired frame buffer size.

The function will allocate memory accordingly. The frame size depends on the desired frame resolution (Left, Top, Width, Height), depth of the CCD chip (bpp), and binning settings. You must set the frame size any time any of the prior parameters gets updated.

Parameters
nbufsize of buffer in bytes.
allocMemif True, it will allocate memory of nbut size bytes.

◆ setFrameBufferSize() [2/2]

void INDI::CCDChip::setFrameBufferSize ( int  nbuf,
bool  allocMem = true 
)

setFrameBufferSize Set desired frame buffer size.

The function will allocate memory accordingly. The frame size depends on the desired frame resolution (Left, Top, Width, Height), depth of the CCD chip (bpp), and binning settings. You must set the frame size any time any of the prior parameters gets updated.

Parameters
nbufsize of buffer in bytes.
allocMemif True, it will allocate memory of nbut size bytes.

◆ setFrameType() [1/2]

void INDI::CCDChip::setFrameType ( CCD_FRAME  type)

setFrameType Set desired frame type for next exposure.

Parameters
typedesired CCD frame type.

◆ setFrameType() [2/2]

void INDI::CCDChip::setFrameType ( CCD_FRAME  type)

setFrameType Set desired frame type for next exposure.

Parameters
typedesired CCD frame type.

◆ setImageExtension() [1/2]

void INDI::CCDChip::setImageExtension ( const char *  ext)

setImageExtension Set image exntension

Parameters
extextension (fits, jpeg, raw..etc)

◆ setImageExtension() [2/2]

void INDI::CCDChip::setImageExtension ( const char *  ext)

setImageExtension Set image exntension

Parameters
extextension (fits, jpeg, raw..etc)

◆ setInterlaced() [1/2]

void INDI::CCDChip::setInterlaced ( bool  intr)

setInterlaced Set whether the CCD chip is interlaced or not?

Parameters
intrIf true, the CCD chip is interlaced.

◆ setInterlaced() [2/2]

void INDI::CCDChip::setInterlaced ( bool  intr)

setInterlaced Set whether the CCD chip is interlaced or not?

Parameters
intrIf true, the CCD chip is interlaced.

◆ setMinMaxStep() [1/2]

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

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.

◆ setMinMaxStep() [2/2]

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

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.

◆ setNAxis() [1/2]

void INDI::CCDChip::setNAxis ( int  value)

setNAxis Set FITS number of axis

Parameters
valuenumber of axis

◆ setNAxis() [2/2]

void INDI::CCDChip::setNAxis ( int  value)

setNAxis Set FITS number of axis

Parameters
valuenumber of axis

◆ setPixelSize() [1/2]

void INDI::CCDChip::setPixelSize ( float  x,
float  y 
)

setPixelSize Set CCD Chip pixel size

Parameters
xHorziontal pixel size in microns.
yVertical pixel size in microns.

◆ setPixelSize() [2/2]

void INDI::CCDChip::setPixelSize ( float  x,
float  y 
)

setPixelSize Set CCD Chip pixel size

Parameters
xHorziontal pixel size in microns.
yVertical pixel size in microns.

◆ setResolution() [1/2]

void INDI::CCDChip::setResolution ( int  x,
int  y 
)

setResolution set CCD Chip resolution

Parameters
xwidth
yheight

◆ setResolution() [2/2]

void INDI::CCDChip::setResolution ( int  x,
int  y 
)

setResolution set CCD Chip resolution

Parameters
xwidth
yheight

Friends And Related Function Documentation

◆ CCD

CCD
friend

◆ StreamRecoder

StreamRecoder
friend

Member Data Documentation

◆ AbortExposureS

ISwitch INDI::CCDChip::AbortExposureS
private

◆ AbortExposureSP

ISwitchVectorProperty INDI::CCDChip::AbortExposureSP
private

◆ BinFrame

uint8_t * INDI::CCDChip::BinFrame = nullptr
private

◆ BinX

int INDI::CCDChip::BinX
private

Binning requested in the x direction.

◆ BinY

int INDI::CCDChip::BinY
private

Binning requested in the y direction.

◆ BPP

int INDI::CCDChip::BPP
private

Bytes per Pixel.

◆ CompressS

ISwitch INDI::CCDChip::CompressS
private

◆ CompressSP

ISwitchVectorProperty INDI::CCDChip::CompressSP
private

◆ exposureDuration

double INDI::CCDChip::exposureDuration
private

◆ FitsB

IBLOB INDI::CCDChip::FitsB
private

◆ FitsBP

IBLOBVectorProperty INDI::CCDChip::FitsBP
private

◆ FrameType

CCD_FRAME INDI::CCDChip::FrameType
private

◆ FrameTypeS

ISwitch INDI::CCDChip::FrameTypeS
private

◆ FrameTypeSP

ISwitchVectorProperty INDI::CCDChip::FrameTypeSP
private

◆ ImageBinN

INumber INDI::CCDChip::ImageBinN
private

◆ ImageBinNP

INumberVectorProperty INDI::CCDChip::ImageBinNP
private

◆ ImageExposureN

INumber INDI::CCDChip::ImageExposureN
private

◆ ImageExposureNP

INumberVectorProperty INDI::CCDChip::ImageExposureNP
private

◆ imageExtention

char INDI::CCDChip::imageExtention
private

◆ ImageFrameN

INumber INDI::CCDChip::ImageFrameN
private

◆ ImageFrameNP

INumberVectorProperty INDI::CCDChip::ImageFrameNP
private

◆ ImagePixelSizeN

INumber INDI::CCDChip::ImagePixelSizeN
private

◆ ImagePixelSizeNP

INumberVectorProperty INDI::CCDChip::ImagePixelSizeNP
private

◆ Interlaced

bool INDI::CCDChip::Interlaced = false
private

◆ lastRapidX

int INDI::CCDChip::lastRapidX
private

◆ lastRapidY

int INDI::CCDChip::lastRapidY
private

◆ NAxis

int INDI::CCDChip::NAxis
private

of Axis

◆ PixelSizex

float INDI::CCDChip::PixelSizex
private

Pixel size in microns, x direction.

◆ PixelSizey

float INDI::CCDChip::PixelSizey
private

Pixel size in microns, y direction.

◆ RapidGuideDataN

INumber INDI::CCDChip::RapidGuideDataN
private

◆ RapidGuideDataNP

INumberVectorProperty INDI::CCDChip::RapidGuideDataNP
private

◆ RapidGuideS

ISwitch INDI::CCDChip::RapidGuideS
private

◆ RapidGuideSetupS

ISwitch INDI::CCDChip::RapidGuideSetupS
private

◆ RapidGuideSetupSP

ISwitchVectorProperty INDI::CCDChip::RapidGuideSetupSP
private

◆ RapidGuideSP

ISwitchVectorProperty INDI::CCDChip::RapidGuideSP
private

◆ RawFrame

uint8_t * INDI::CCDChip::RawFrame = nullptr
private

◆ RawFrameSize

int INDI::CCDChip::RawFrameSize = 0
private

◆ ResetS

ISwitch INDI::CCDChip::ResetS
private

◆ ResetSP

ISwitchVectorProperty INDI::CCDChip::ResetSP
private

◆ SendCompressed

bool INDI::CCDChip::SendCompressed = false
private

◆ startExposureTime

timeval INDI::CCDChip::startExposureTime
private

◆ SubH

int INDI::CCDChip::SubH
private

UNBINNED height of the subframe.

◆ SubW

int INDI::CCDChip::SubW
private

UNBINNED width of the subframe.

◆ SubX

int INDI::CCDChip::SubX
private

Left side of the subframe we are requesting.

◆ SubY

int INDI::CCDChip::SubY
private

Top of the subframe requested.

◆ XRes

int INDI::CCDChip::XRes
private

Native x resolution of the ccd.

◆ YRes

int INDI::CCDChip::YRes
private

Native y resolution of the ccd.


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