libapogee  3.0.3079
Public Member Functions | Protected Member Functions
CamGen2Base Class Reference

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:
ApogeeCam AltaF Ascent Quad HiC

List of all members.

Public Member Functions

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 ()

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)

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

Copyright(c) 2009 Apogee Instruments, Inc.


Member Function Documentation

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.

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.

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

Downloads the image data from the camera.

Parameters:
[out]outVector that will recieve the image data
Exceptions:
std::runtime_error

Implements ApogeeCam.

Returns the current imaging state of the camera.

Exceptions:
std::runtime_error

Implements ApogeeCam.

int32_t CamGen2Base::GetNumAds ( ) [virtual]

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

Exceptions:
std::runtime_error

Implements ApogeeCam.

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

Exceptions:
std::runtime_error

Implements ApogeeCam.

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.

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]DigitizeIf 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.


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