This is the base class for the second generation apogee cameras (Ascent, Aspen, etc). This is a derived class of the ApogeeCam, which contains the function common to both Alta and second generation cameras. More...

#include <CamGen2Base.h>

Inheritance diagram for CamGen2Base:

Collaboration diagram for CamGen2Base:

Public Member Functions
virtual	~CamGen2Base ()

CameraStatusRegs	GetStatus ()

Apg::Status	GetImagingStatus ()

void	GetImage (std::vector< uint16_t > &out)

void	StopExposure (bool Digitize)

uint32_t	GetAvailableMemory ()

int32_t	GetNumAds ()

double	GetCoolerDrive ()

double	GetTempHeatsink ()

Public Member Functions inherited from ApogeeCam
virtual	~ApogeeCam ()

void	Reset ()

uint16_t	ReadReg (uint16_t reg)

void	WriteReg (uint16_t reg, uint16_t value)

void	SetRoiNumRows (uint16_t rows)

void	SetRoiNumCols (uint16_t cols)

uint16_t	GetRoiNumRows ()

uint16_t	GetRoiNumCols ()

void	SetRoiStartRow (uint16_t row)

void	SetRoiStartCol (uint16_t col)

uint16_t	GetRoiStartRow ()

uint16_t	GetRoiStartCol ()

void	SetRoiBinRow (uint16_t bin)

uint16_t	GetRoiBinRow ()

void	SetRoiBinCol (uint16_t bin)

uint16_t	GetRoiBinCol ()

uint16_t	GetFirmwareRev ()

void	SetImageCount (uint16_t count)

uint16_t	GetImageCount ()

uint16_t	GetImgSequenceCount ()

void	SetSequenceDelay (double delay)

double	GetSequenceDelay ()

void	SetVariableSequenceDelay (bool variable)

bool	GetVariableSequenceDelay ()

void	SetTdiRate (double TdiRate)

double	GetTdiRate ()

void	SetTdiRows (uint16_t TdiRows)

uint16_t	GetTdiRows ()

uint16_t	GetTdiCounter ()

void	SetTdiBinningRows (uint16_t bin)

uint16_t	GetTdiBinningRows ()

void	SetKineticsSectionHeight (uint16_t height)

uint16_t	GetKineticsSectionHeight ()

void	SetKineticsSections (uint16_t sections)

uint16_t	GetKineticsSections ()

void	SetKineticsShiftInterval (double interval)

double	GetKineticsShiftInterval ()

void	SetShutterStrobePosition (double position)

double	GetShutterStrobePosition ()

void	SetShutterStrobePeriod (double period)

double	GetShutterStrobePeriod ()

void	SetShutterCloseDelay (double delay)

double	GetShutterCloseDelay ()

void	SetCoolerBackoffPoint (double point)

double	GetCoolerBackoffPoint ()

void	SetCoolerSetPoint (double point)

double	GetCoolerSetPoint ()

Apg::CameraMode	GetCameraMode ()

void	SetCameraMode (Apg::CameraMode mode)

void	SetFastSequence (bool TurnOn)

bool	IsFastSequenceOn ()

void	SetBulkDownload (bool TurnOn)

bool	IsBulkDownloadOn ()

void	SetPipelineDownload (bool TurnOn)

bool	IsPipelineDownloadOn ()

void	SetIoPortAssignment (uint16_t assignment)

uint16_t	GetIoPortAssignment ()

void	SetIoPortBlankingBits (uint16_t blankingBits)

uint16_t	GetIoPortBlankingBits ()

void	SetIoPortDirection (uint16_t direction)

uint16_t	GetIoPortDirection ()

void	SetIoPortData (uint16_t data)

uint16_t	GetIoPortData ()

void	SetPreFlash (bool TurnOn)

bool	GetPreFlash ()

void	SetExternalTrigger (bool TurnOn, Apg::TriggerMode trigMode, Apg::TriggerType trigType)

bool	IsTriggerNormEachOn ()

bool	IsTriggerNormGroupOn ()

bool	IsTriggerTdiKinEachOn ()

bool	IsTriggerTdiKinGroupOn ()

bool	IsTriggerExternalShutterOn ()

bool	IsTriggerExternalReadoutOn ()

void	SetShutterState (Apg::ShutterState state)

Apg::ShutterState	GetShutterState ()

bool	IsShutterForcedOpen ()

bool	IsShutterForcedClosed ()

bool	IsShutterOpen ()

void	SetShutterAmpCtrl (bool TurnOn)

bool	IsShutterAmpCtrlOn ()

void	SetCooler (bool TurnOn)

Apg::CoolerStatus	GetCoolerStatus ()

bool	IsCoolerOn ()

double	GetTempCcd ()

void	SetCcdAdcResolution (Apg::Resolution res)

Apg::Resolution	GetCcdAdcResolution ()

void	SetCcdAdcSpeed (Apg::AdcSpeed speed)

Apg::AdcSpeed	GetCcdAdcSpeed ()

uint16_t	GetMaxBinCols ()

uint16_t	GetMaxBinRows ()

uint16_t	GetMaxImgCols ()

uint16_t	GetMaxImgRows ()

uint16_t	GetTotalRows ()

uint16_t	GetTotalCols ()

uint16_t	GetNumOverscanCols ()

bool	IsInterline ()

CamModel::PlatformType	GetPlatformType ()

void	SetLedAState (Apg::LedState state)

Apg::LedState	GetLedAState ()

void	SetLedBState (Apg::LedState state)

Apg::LedState	GetLedBState ()

void	SetLedMode (Apg::LedMode mode)

Apg::LedMode	GetLedMode ()

std::string	GetInfo ()

std::string	GetModel ()

std::string	GetSensor ()

void	SetFlushCommands (bool Disable)

bool	AreFlushCmdsDisabled ()

void	SetPostExposeFlushing (bool Disable)

bool	IsPostExposeFlushingDisabled ()

double	GetPixelWidth ()

double	GetPixelHeight ()

double	GetMinExposureTime ()

double	GetMaxExposureTime ()

bool	IsColor ()

bool	IsCoolingSupported ()

bool	IsCoolingRegulated ()

double	GetInputVoltage ()

CamModel::InterfaceType	GetInterfaceType ()

void	GetUsbVendorInfo (uint16_t &VendorId, uint16_t &ProductId, uint16_t &DeviceId)

bool	IsCCD ()

void	PauseTimer (bool TurnOn)

bool	IsSerialASupported ()

bool	IsSerialBSupported ()

void	SetFlushBinningRows (uint16_t bin)

uint16_t	GetFlushBinningRows ()

bool	IsOverscanDigitized ()

void	SetDigitizeOverscan (const bool TurnOn)

void	SetAdcGain (uint16_t gain, int32_t ad, int32_t channel)

uint16_t	GetAdcGain (int32_t ad, int32_t channel)

void	SetAdcOffset (uint16_t offset, int32_t ad, int32_t channel)

uint16_t	GetAdcOffset (int32_t ad, int32_t channel)

bool	IsInitialized ()

bool	IsConnected ()

void	SetAdSimMode (bool TurnOn)

bool	IsAdSimModeOn ()

void	SetLedBrightness (double PercentIntensity)

double	GetLedBrightness ()

std::string	GetDriverVersion ()

std::string	GetUsbFirmwareVersion ()

std::string	GetSerialNumber ()

CamInfo::StrDb	ReadStrDatabase ()

void	WriteStrDatabase (CamInfo::StrDb &info)

virtual void	OpenConnection (const std::string &ioType, const std::string &DeviceAddr, const uint16_t FirmwareRev, const uint16_t Id)=0

virtual void	CloseConnection ()=0

virtual void	Init ()=0

virtual void	StartExposure (double Duration, bool IsLight)=0

virtual int32_t	GetNumAdChannels ()=0

virtual void	SetFanMode (Apg::FanMode mode, bool PreCondCheck=true)=0

virtual Apg::FanMode	GetFanMode ()=0

void	UpdateAlta (const std::string FilenameCamCon, const std::string FilenameBufCon, const std::string FilenameFx2, const std::string FilenameGpifCamCon, const std::string FilenameGpifBufCon, const std::string FilenameGpifFifo)

void	UpdateAscentOrAltaF (const std::string FilenameFpga, const std::string FilenameFx2, const std::string FilenameDescriptor)

void	UpdateAspen (const std::string FilenameFpga, const std::string FilenameFx2, const std::string FilenameDescriptor, const std::string FilenameWebPage, const std::string FilenameWebServer, const std::string FilenameWebCfg)

Protected Member Functions
	CamGen2Base (const uint16_t FirmwareRev, const uint16_t Id, CamModel::PlatformType platform)

	CamGen2Base (CamModel::PlatformType platform)

uint16_t	ExposureZ ()

uint16_t	GetImageZ ()

uint16_t	GetIlluminationMask ()

void	DefaultStartExposure (double Duration, bool IsLight, bool IssueReset=true)

Protected Member Functions inherited from ApogeeCam
	ApogeeCam (CamModel::PlatformType platform)

void	VerifyFrmwrRev ()

void	LogConnectAndDisconnect (bool Connect)

void	ExectuePreFlash ()

void	SetExpsoureTime (double Duration)

void	IssueExposeCmd (bool IsLight)

void	IsThereAStatusError (uint16_t statusReg)

bool	IsImgDone (const CameraStatusRegs &statusObj)

Apg::Status	LogAndReturnStatus (Apg::Status status, const CameraStatusRegs &statusObj)

void	SupsendCooler (bool &resume)

void	ResumeCooler ()

void	WaitForCoolerSuspendBit (const uint16_t mask, const bool IsHigh)

void	InitShutterCloseDelay ()

void	StopExposureModeNorm (bool Digitize)

void	Reset (bool Flush)

void	HardStopExposure (const std::string &msg)

void	GrabImageAndThrowItAway ()

void	AdcParamCheck (const int32_t ad, const int32_t channel, const std::string &fxName)

void	SetNumAdOutputs (const uint16_t num)

bool	CheckAndWaitForStatus (Apg::Status desired, Apg::Status &acutal)

void	CancelExposureNoThrow ()

double	DefaultGetTempHeatsink ()

void	DefaultInit ()

void	ClearAllRegisters ()

void	DefaultCfgCamFromId (uint16_t CameraId)

void	DefaultSetFanMode (Apg::FanMode mode, bool PreCondCheck)

Apg::FanMode	DefaultGetFanMode ()

void	DefaultCloseConnection ()

virtual void	CfgCamFromId (uint16_t CameraId)=0

virtual void	ExposureAndGetImgRC (uint16_t &r, uint16_t &c)=0

virtual void	FixImgFromCamera (const std::vector< uint16_t > &data, std::vector< uint16_t > &out, int32_t rows, int32_t cols)=0

Private Member Functions
	CamGen2Base (const CamGen2Base &)

CamGen2Base &	operator= (CamGen2Base &)

Private Attributes
const std::string	m_fileName

Additional Inherited Members
Protected Attributes inherited from ApogeeCam
std::shared_ptr< CameraIo >	m_CamIo

std::shared_ptr< PlatformData >	m_CameraConsts

std::shared_ptr< CApnCamData >	m_CamCfgData

std::shared_ptr< ModeFsm >	m_CamMode

std::shared_ptr< CcdAcqParams >	m_CcdAcqSettings

std::shared_ptr< ApgTimer >	m_ExposureTimer

CamModel::PlatformType	m_PlatformType

const std::string	m_fileName

uint16_t	m_FirmwareVersion

uint16_t	m_Id

uint16_t	m_NumImgsDownloaded

bool	m_ImageInProgress

bool	m_IsPreFlashOn

bool	m_IsInitialized

bool	m_IsConnected

double	m_LastExposureTime

Detailed Description

This is the base class for the second generation apogee cameras (Ascent, Aspen, etc). This is a derived class of the ApogeeCam, which contains the function common to both Alta and second generation cameras.

This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/.

Constructor & Destructor Documentation

◆ ~CamGen2Base()

CamGen2Base::~CamGen2Base ( )

virtual

◆ CamGen2Base() [1/3]

CamGen2Base::CamGen2Base	(	const uint16_t	FirmwareRev,
		const uint16_t	Id,
		CamModel::PlatformType	platform
	)

protected

◆ CamGen2Base() [2/3]

CamGen2Base::CamGen2Base ( CamModel::PlatformType platform )

protected

◆ CamGen2Base() [3/3]

CamGen2Base::CamGen2Base ( const CamGen2Base & )

private

Member Function Documentation

◆ DefaultStartExposure()

void CamGen2Base::DefaultStartExposure	(	double	Duration,
		bool	IsLight,
		bool	IssueReset = `true`
	)

protected

◆ ExposureZ()

uint16_t CamGen2Base::ExposureZ ( )

protectedvirtual

Implements ApogeeCam.

◆ GetAvailableMemory()

uint32_t CamGen2Base::GetAvailableMemory ( )

virtual

Returns the amount of available memory for storing images in terms of kilobytes (KB).

Exceptions

std::runtime_error

Implements ApogeeCam.

◆ GetCoolerDrive()

double CamGen2Base::GetCoolerDrive ( )

virtual

Drive level applied to the temp controller. Expressed as a percentage from 0% to 100%.

Exceptions

std::runtime_error

Implements ApogeeCam.

◆ GetIlluminationMask()

uint16_t CamGen2Base::GetIlluminationMask ( )

protectedvirtual

Implements ApogeeCam.

◆ GetImage()

void CamGen2Base::GetImage ( std::vector< uint16_t > & out )

virtual

Downloads the image data from the camera.

Parameters

[out] out Vector that will recieve the image data

Exceptions

std::runtime_error

Implements ApogeeCam.

◆ GetImageZ()

uint16_t CamGen2Base::GetImageZ ( )

protectedvirtual

Implements ApogeeCam.

◆ GetImagingStatus()

Apg::Status CamGen2Base::GetImagingStatus ( )

virtual

Returns the current imaging state of the camera.

Exceptions

std::runtime_error

Implements ApogeeCam.

◆ GetNumAds()

int32_t CamGen2Base::GetNumAds ( )

virtual

Returns the number of analog to digital (AD) converters on the camera.

Exceptions

std::runtime_error

Implements ApogeeCam.

◆ GetStatus()

CameraStatusRegs CamGen2Base::GetStatus ( )

virtual

Returns the camera's status registers as a CameraStatusRegs class.

Exceptions

std::runtime_error

Implements ApogeeCam.

◆ GetTempHeatsink()

double CamGen2Base::GetTempHeatsink ( )

virtual

Returns the current Heatsink temperature in degrees Celsius. The Ascent camera platform does not support reading the heatsink temperature, and this property will return -255.

Exceptions

std::runtime_error

Implements ApogeeCam.

◆ operator=()

CamGen2Base& CamGen2Base::operator= ( CamGen2Base & )

private

◆ StopExposure()

void CamGen2Base::StopExposure ( bool Digitize )

virtual

This method halts an in progress exposure. If this method is called and there is no exposure in progress a std::runtime_error exception is thrown.

Parameters

[in] Digitize If set to true, then the application must call GetImage() to retrieve the image data and to put the camera in a good state for the next exposure. If set to false, then an application should not call GetImage().

Exceptions

std::runtime_error

Implements ApogeeCam.

Member Data Documentation

◆ m_fileName

const std::string CamGen2Base::m_fileName

private

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

ln/3rdparty/src/indilib/indi-1.7.4/3rdparty/libapogee/CamGen2Base.h
ln/3rdparty/src/indilib/indi-1.7.4/3rdparty/libapogee/CamGen2Base.cpp

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ~CamGen2Base()

◆ CamGen2Base() [1/3]

◆ CamGen2Base() [2/3]

◆ CamGen2Base() [3/3]

Member Function Documentation

◆ DefaultStartExposure()

◆ ExposureZ()

◆ GetAvailableMemory()

◆ GetCoolerDrive()

◆ GetIlluminationMask()

◆ GetImage()

◆ GetImageZ()

◆ GetImagingStatus()

◆ GetNumAds()

◆ GetStatus()

◆ GetTempHeatsink()

◆ operator=()

◆ StopExposure()

Member Data Documentation

◆ m_fileName