TwiceAsNice  2019-02-18
Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
AltaCcdAcqParams Class Reference

derived class for managing the Alta's ADCs, horizontal pattern files, and roi parameters More...

#include <AltaCcdAcqParams.h>

Inheritance diagram for AltaCcdAcqParams:
Inheritance graph
Collaboration diagram for AltaCcdAcqParams:
Collaboration graph

Public Member Functions

 AltaCcdAcqParams (std::shared_ptr< CApnCamData > &camData, std::shared_ptr< CameraIo > &camIo, std::shared_ptr< PlatformData > &platformData)
 
virtual ~AltaCcdAcqParams ()
 
void Init ()
 
void SetResolution (Apg::Resolution res)
 
void SetSpeed (Apg::AdcSpeed speed)
 
void Set12BitGain (uint16_t gain)
 
uint16_t Get12BitGain ()
 
void Set12BitOffset (uint16_t offset)
 
uint16_t Get12BitOffset ()
 
double Get16bitGain ()
 
bool IsAdsSimModeOn ()
 
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)
 
uint16_t GetPixelShift ()
 
- Public Member Functions inherited from CcdAcqParams
virtual ~CcdAcqParams ()
 
Apg::Resolution GetResolution ()
 
Apg::AdcSpeed GetSpeed ()
 
void SetRoiStartRow (uint16_t row)
 
void SetRoiStartCol (uint16_t col)
 
void SetRoiNumRows (uint16_t rows)
 
void SetRoiNumCols (uint16_t cols)
 
uint16_t GetRoiStartRow ()
 
uint16_t GetRoiStartCol ()
 
uint16_t GetRoiNumRows ()
 
uint16_t GetRoiNumCols ()
 
uint16_t GetNumCols2Bin ()
 
uint16_t GetNumRows2Bin ()
 
uint16_t GetMaxBinCols ()
 
uint16_t GetMaxBinRows ()
 
void SetNumCols2Bin (uint16_t bin)
 
void SetNumRows2Bin (uint16_t bin)
 
void SetImagingRegs (const uint16_t FirmwareVer)
 
void UpdateApnCamData (std::shared_ptr< CApnCamData > &newCamData)
 
void SetAdsSimMode (bool TurnOn)
 
bool IsOverscanDigitized ()
 
void SetDigitizeOverscan (const bool TurnOn)
 

Protected Member Functions

uint16_t GetCcdImgRows ()
 
uint16_t GetCcdImgCols ()
 
uint16_t GetCcdImgBinRows ()
 
uint16_t GetCcdImgBinCols ()
 
uint16_t GetTotalCcdCols ()
 
uint16_t CalcHPostRoiSkip (uint16_t HPreRoiSkip, uint16_t UnbinnedRoiCols)
 
bool IsColCalcGood (uint16_t UnbinnedRoiCols, uint16_t PreRoiSkip, uint16_t PostRoiSkip)
 
CamCfg::APN_HPATTERN_FILE GetHPattern (Apg::AdcSpeed speed, CcdAcqParams::HPatternType ptype)
 
- Protected Member Functions inherited from CcdAcqParams
CcdAcqParams::CcdReadoutType GetReadoutType ()
 
 CcdAcqParams (std::shared_ptr< CApnCamData > &camData, std::shared_ptr< CameraIo > &camIo, std::shared_ptr< PlatformData > &platformData)
 
void SetRoiPattern (uint16_t binning)
 
void LoadHorizontalPatterns (Apg::AdcSpeed speed, uint16_t binning)
 
void LoadRoiPattern (Apg::AdcSpeed speed, uint16_t binning)
 
CamCfg::APN_HPATTERN_FILE DefaultGetHPattern (Apg::AdcSpeed speed, CcdAcqParams::HPatternType ptype)
 
void LoadAllPatternFiles (Apg::AdcSpeed speed, uint16_t binning)
 
void GetPostVer11Settings (std::vector< std::pair< uint16_t, uint16_t > > &settings, uint16_t pixelShift)
 
void GetPreVer11Settings (std::vector< std::pair< uint16_t, uint16_t > > &settings, uint16_t pixelShift)
 
void AppendCommonHorizontals (std::vector< std::pair< uint16_t, uint16_t > > &settings, uint16_t pixelShift)
 
void CalcVerticalValues (uint16_t &A2_RoiRows, uint16_t &A2_RoiBinRows, uint16_t &A5_RoiRows, uint16_t &A5_RoiBinRows)
 
void CalcVerticalValues (uint16_t &A1_RoiRows, uint16_t &A1_RoiBinRows, uint16_t &A2_RoiRows, uint16_t &A2_RoiBinRows, uint16_t &A4_RoiRows, uint16_t &A4_RoiBinRows, uint16_t &A5_RoiRows, uint16_t &A5_RoiBinRows)
 
void BalanceSections (const uint16_t BottomMaxRows, const uint16_t TopMaxBin, uint16_t &TopRoiRows, uint16_t &TopRoiBinRows, uint16_t &BottomRoiRows, uint16_t &BottomRoiBinRows)
 
uint16_t GetMaxFastBinCols ()
 
uint16_t GetMaxNormalBinCols ()
 

Private Member Functions

void PrimeAdc ()
 
 AltaCcdAcqParams (const AltaCcdAcqParams &)
 
AltaCcdAcqParamsoperator= (AltaCcdAcqParams &)
 

Private Attributes

std::string m_fileName
 
uint16_t m_Adc12BitGain
 
uint16_t m_Adc12BitOffset
 

Additional Inherited Members

- Protected Types inherited from CcdAcqParams
enum  CcdReadoutType { UNKNOWN_READOUT, SINGLE_READOUT, DUAL_READOUT, QUAD_READOUT }
 
enum  HPatternType { CLAMP, SKIP, ROI }
 
- Protected Attributes inherited from CcdAcqParams
std::string m_fileName
 
std::shared_ptr< CApnCamDatam_CamData
 
std::shared_ptr< CameraIom_CamIo
 
std::shared_ptr< PlatformDatam_PlatformData
 
Apg::Resolution m_AdcRes
 
Apg::AdcSpeed m_speed
 
uint16_t m_RoiStartRow
 
uint16_t m_RoiStartCol
 
uint16_t m_RoiNumRows
 
uint16_t m_RoiNumCols
 
uint16_t m_NumCols2Bin
 
uint16_t m_NumRows2Bin
 
bool m_DigitizeOverScan
 

Detailed Description

derived class for managing the Alta's ADCs, horizontal pattern files, and roi parameters

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/.

Copyright(c) 2010 Apogee Instruments, Inc.

Constructor & Destructor Documentation

◆ AltaCcdAcqParams() [1/2]

AltaCcdAcqParams::AltaCcdAcqParams ( std::shared_ptr< CApnCamData > &  camData,
std::shared_ptr< CameraIo > &  camIo,
std::shared_ptr< PlatformData > &  platformData 
)

◆ ~AltaCcdAcqParams()

AltaCcdAcqParams::~AltaCcdAcqParams ( )
virtual

◆ AltaCcdAcqParams() [2/2]

AltaCcdAcqParams::AltaCcdAcqParams ( const AltaCcdAcqParams )
private

Member Function Documentation

◆ CalcHPostRoiSkip()

uint16_t AltaCcdAcqParams::CalcHPostRoiSkip ( uint16_t  HPreRoiSkip,
uint16_t  UnbinnedRoiCols 
)
protectedvirtual

Implements CcdAcqParams.

◆ Get12BitGain()

uint16_t AltaCcdAcqParams::Get12BitGain ( )
inline

◆ Get12BitOffset()

uint16_t AltaCcdAcqParams::Get12BitOffset ( )
inline

◆ Get16bitGain()

double AltaCcdAcqParams::Get16bitGain ( )

◆ GetAdcGain()

uint16_t AltaCcdAcqParams::GetAdcGain ( int32_t  ad,
int32_t  channel 
)
virtual

Implements CcdAcqParams.

◆ GetAdcOffset()

uint16_t AltaCcdAcqParams::GetAdcOffset ( int32_t  ad,
int32_t  channel 
)
virtual

Implements CcdAcqParams.

◆ GetCcdImgBinCols()

uint16_t AltaCcdAcqParams::GetCcdImgBinCols ( )
inlineprotectedvirtual

Implements CcdAcqParams.

◆ GetCcdImgBinRows()

uint16_t AltaCcdAcqParams::GetCcdImgBinRows ( )
inlineprotectedvirtual

Implements CcdAcqParams.

◆ GetCcdImgCols()

uint16_t AltaCcdAcqParams::GetCcdImgCols ( )
inlineprotectedvirtual

Implements CcdAcqParams.

◆ GetCcdImgRows()

uint16_t AltaCcdAcqParams::GetCcdImgRows ( )
inlineprotectedvirtual

Implements CcdAcqParams.

◆ GetHPattern()

CamCfg::APN_HPATTERN_FILE AltaCcdAcqParams::GetHPattern ( Apg::AdcSpeed  speed,
CcdAcqParams::HPatternType  ptype 
)
protectedvirtual

Implements CcdAcqParams.

◆ GetPixelShift()

uint16_t AltaCcdAcqParams::GetPixelShift ( )
virtual

Implements CcdAcqParams.

◆ GetTotalCcdCols()

uint16_t AltaCcdAcqParams::GetTotalCcdCols ( )
protectedvirtual

Implements CcdAcqParams.

◆ Init()

void AltaCcdAcqParams::Init ( )
virtual

Implements CcdAcqParams.

◆ IsAdsSimModeOn()

bool AltaCcdAcqParams::IsAdsSimModeOn ( )
virtual

Implements CcdAcqParams.

◆ IsColCalcGood()

bool AltaCcdAcqParams::IsColCalcGood ( uint16_t  UnbinnedRoiCols,
uint16_t  PreRoiSkip,
uint16_t  PostRoiSkip 
)
protectedvirtual

Implements CcdAcqParams.

◆ operator=()

AltaCcdAcqParams& AltaCcdAcqParams::operator= ( AltaCcdAcqParams )
private

◆ PrimeAdc()

void AltaCcdAcqParams::PrimeAdc ( )
private

◆ Set12BitGain()

void AltaCcdAcqParams::Set12BitGain ( uint16_t  gain)

◆ Set12BitOffset()

void AltaCcdAcqParams::Set12BitOffset ( uint16_t  offset)

◆ SetAdcGain()

void AltaCcdAcqParams::SetAdcGain ( uint16_t  gain,
int32_t  ad,
int32_t  channel 
)
virtual

Implements CcdAcqParams.

◆ SetAdcOffset()

void AltaCcdAcqParams::SetAdcOffset ( uint16_t  offset,
int32_t  ad,
int32_t  channel 
)
virtual

Implements CcdAcqParams.

◆ SetResolution()

void AltaCcdAcqParams::SetResolution ( Apg::Resolution  res)
virtual

Implements CcdAcqParams.

◆ SetSpeed()

void AltaCcdAcqParams::SetSpeed ( Apg::AdcSpeed  speed)
virtual

Implements CcdAcqParams.

Member Data Documentation

◆ m_Adc12BitGain

uint16_t AltaCcdAcqParams::m_Adc12BitGain
private

◆ m_Adc12BitOffset

uint16_t AltaCcdAcqParams::m_Adc12BitOffset
private

◆ m_fileName

std::string AltaCcdAcqParams::m_fileName
private

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