USGS

Isis 3.0 Object Programmers' Reference

Home

Isis::CameraDetectorMap Class Reference

#include <CameraDetectorMap.h>

Inheritance diagram for Isis::CameraDetectorMap:

Inheritance graph
[legend]
Collaboration diagram for Isis::CameraDetectorMap:

Collaboration graph
[legend]
List of all members.

Detailed Description

Convert between parent image coordinates and detector coordinates.

This base class is used to convert between parent dector coordinates (sample/line) and detector coordinates for the camera.

See also:
Camera
Author:
2005-02-03 Jeff Anderson

For internal use only.

History:
2009-04-02 Debbie A. Cook Removed obsolete methods IsXAxisTimeDependent,IsYAxisTimeDependent, XAxisDirection, YAxisDirection, SetXAxisDirection, and SetYAxisDirection

Definition at line 46 of file CameraDetectorMap.h.

Public Member Functions

 CameraDetectorMap (Camera *parent=0)
 Default constructor assumes no summing and starting detector offsets.
virtual ~CameraDetectorMap ()
 Destructor.
virtual bool SetParent (const double sample, const double line)
 Compute detector position from a parent image coordinate.
virtual bool SetDetector (const double sample, const double line)
 Compute parent position from a detector coordinate.
double ParentSample () const
 Return parent sample.
double ParentLine () const
 Return parent line.
double DetectorSample () const
 Return detector sample.
double DetectorLine () const
 Return detector line.
void SetStartingDetectorSample (const double sample)
 Set the starting detector sample.
void SetStartingDetectorLine (const double line)
 Set the starting detector line.
void SetDetectorSampleSumming (const double summing)
 Set sample summing mode.
void SetDetectorLineSumming (const double summing)
 Set line summing mode.
virtual double SampleScaleFactor () const
 Return scaling factor for computing sample resolution.
virtual double LineScaleFactor () const
 Return scaling factor for computing line resolution.
virtual double LineRate () const
 Return the line collection rate (0 for framing cameras).

Protected Attributes

Camerap_camera
double p_parentSample
double p_parentLine
double p_detectorLine
double p_detectorSample
double p_detectorSampleSumming
double p_detectorLineSumming
double p_startingDetectorSample
double p_startingDetectorLine
double p_ss
double p_sl

Private Member Functions

void Compute ()
 Compute new offsets whenenver summing or starting sample/lines change.


Constructor & Destructor Documentation

Isis::CameraDetectorMap::CameraDetectorMap ( Camera parent = 0  ) 

Default constructor assumes no summing and starting detector offsets.

Parameters:
parent Camera that will use this detector map

Definition at line 30 of file CameraDetectorMap.cpp.

References Compute(), p_camera, p_detectorLineSumming, p_detectorSampleSumming, p_startingDetectorLine, p_startingDetectorSample, and Isis::Camera::SetDetectorMap().

virtual Isis::CameraDetectorMap::~CameraDetectorMap (  )  [inline, virtual]

Destructor.

Definition at line 51 of file CameraDetectorMap.h.


Member Function Documentation

void Isis::CameraDetectorMap::Compute (  )  [private]

Compute new offsets whenenver summing or starting sample/lines change.

Definition at line 79 of file CameraDetectorMap.cpp.

References p_detectorLineSumming, p_detectorSampleSumming, p_sl, p_ss, p_startingDetectorLine, and p_startingDetectorSample.

Referenced by CameraDetectorMap(), SetDetectorLineSumming(), SetDetectorSampleSumming(), SetStartingDetectorLine(), and SetStartingDetectorSample().

double Isis::CameraDetectorMap::DetectorLine (  )  const [inline]

Return detector line.

Definition at line 67 of file CameraDetectorMap.h.

References p_detectorLine.

Referenced by Isis::Camera::SetImage().

double Isis::CameraDetectorMap::DetectorSample (  )  const [inline]

Return detector sample.

Definition at line 64 of file CameraDetectorMap.h.

References p_detectorSample.

Referenced by Isis::Camera::SetImage().

virtual double Isis::CameraDetectorMap::LineRate (  )  const [inline, virtual]

Return the line collection rate (0 for framing cameras).

Reimplemented in Isis::LineScanCameraDetectorMap, and Isis::RadarPulseMap.

Definition at line 134 of file CameraDetectorMap.h.

virtual double Isis::CameraDetectorMap::LineScaleFactor (  )  const [inline, virtual]

Return scaling factor for computing line resolution.

Definition at line 129 of file CameraDetectorMap.h.

References p_detectorLineSumming.

Referenced by Isis::ControlPoint::ComputeErrors(), Isis::PushFrameCameraGroundMap::FindDistance(), Isis::Camera::LineResolution(), Isis::Odyssey::ThemisIrCamera::SetBand(), Isis::PushFrameCameraDetectorMap::SetDetector(), Isis::PushFrameCameraDetectorMap::SetParent(), and Isis::PushFrameCameraDetectorMap::TotalFramelets().

double Isis::CameraDetectorMap::ParentLine (  )  const [inline]

Return parent line.

Definition at line 61 of file CameraDetectorMap.h.

References p_parentLine.

Referenced by Isis::Camera::RawFocalPlanetoImage(), and Isis::Camera::SetRightAscensionDeclination().

double Isis::CameraDetectorMap::ParentSample (  )  const [inline]

Return parent sample.

Definition at line 58 of file CameraDetectorMap.h.

References p_parentSample.

Referenced by Isis::Camera::RawFocalPlanetoImage(), and Isis::Camera::SetRightAscensionDeclination().

virtual double Isis::CameraDetectorMap::SampleScaleFactor (  )  const [inline, virtual]

Return scaling factor for computing sample resolution.

Definition at line 124 of file CameraDetectorMap.h.

References p_detectorSampleSumming.

Referenced by Isis::ControlPoint::ComputeErrors(), and Isis::Camera::SampleResolution().

bool Isis::CameraDetectorMap::SetDetector ( const double  sample,
const double  line 
) [virtual]

Compute parent position from a detector coordinate.

This method will compute a parent sample/line given a detector coordinate

Parameters:
sample Sample number in the detector
line Line number in the detector
Returns:
conversion successful

Reimplemented in Isis::LineScanCameraDetectorMap, Isis::PushFrameCameraDetectorMap, Isis::RadarPulseMap, Isis::VariableLineScanCameraDetectorMap, and Isis::Mgs::MocWideAngleDetectorMap.

Definition at line 52 of file CameraDetectorMap.cpp.

References p_detectorLine, p_detectorLineSumming, p_detectorSample, p_detectorSampleSumming, p_parentLine, p_parentSample, p_sl, and p_ss.

Referenced by Isis::Camera::RawFocalPlanetoImage(), Isis::VariableLineScanCameraDetectorMap::SetDetector(), Isis::RadarPulseMap::SetDetector(), Isis::PushFrameCameraDetectorMap::SetDetector(), Isis::LineScanCameraDetectorMap::SetDetector(), and Isis::Camera::SetRightAscensionDeclination().

void Isis::CameraDetectorMap::SetDetectorLineSumming ( const double  summing  )  [inline]

Set line summing mode.

Use this method to specify if detector lines are summed/averaged. That is, one image lines represents the average of N detectors. If not set the default is 1.

Parameters:
summing Line summing mode

Definition at line 118 of file CameraDetectorMap.h.

References Compute(), and p_detectorLineSumming.

Referenced by Isis::Mro::HiriseCamera::HiriseCamera(), Cassini::IssNACamera::IssNACamera(), Cassini::IssWACamera::IssWACamera(), Isis::Lro::LroWideAngleCamera::LroWideAngleCamera(), Isis::Mro::MarciCamera::MarciCamera(), Isis::Mgs::MocNarrowAngleCamera::MocNarrowAngleCamera(), Galileo::SsiCamera::SsiCamera(), Isis::Odyssey::ThemisIrCamera::ThemisIrCamera(), and Isis::Odyssey::ThemisVisCamera::ThemisVisCamera().

void Isis::CameraDetectorMap::SetDetectorSampleSumming ( const double  summing  )  [inline]

Set sample summing mode.

Use this method to specify if detector samples are summed/averaged. That is, one image sample represents the average of N detectors. If not set the default is 1.

Parameters:
summing Sample summing mode

Definition at line 104 of file CameraDetectorMap.h.

References Compute(), and p_detectorSampleSumming.

Referenced by Isis::Mro::CTXCamera::CTXCamera(), Isis::Mro::HiriseCamera::HiriseCamera(), Isis::Mex::HrscCamera::HrscCamera(), Cassini::IssNACamera::IssNACamera(), Cassini::IssWACamera::IssWACamera(), Isis::Lro::LroNarrowAngleCamera::LroNarrowAngleCamera(), Isis::Lro::LroWideAngleCamera::LroWideAngleCamera(), Isis::Mro::MarciCamera::MarciCamera(), Isis::Mgs::MocNarrowAngleCamera::MocNarrowAngleCamera(), Galileo::SsiCamera::SsiCamera(), Isis::Odyssey::ThemisIrCamera::ThemisIrCamera(), and Isis::Odyssey::ThemisVisCamera::ThemisVisCamera().

bool Isis::CameraDetectorMap::SetParent ( const double  sample,
const double  line 
) [virtual]

Compute detector position from a parent image coordinate.

This method will compute the detector position from the parent line/sample coordinate

Parameters:
sample Sample number in the parent image
line Line number in the parent image
Returns:
conversion successful

Reimplemented in Isis::LineScanCameraDetectorMap, Isis::PushFrameCameraDetectorMap, Isis::RadarPulseMap, Isis::VariableLineScanCameraDetectorMap, and Isis::Mgs::MocWideAngleDetectorMap.

Definition at line 70 of file CameraDetectorMap.cpp.

References p_detectorLine, p_detectorLineSumming, p_detectorSample, p_detectorSampleSumming, p_parentLine, p_parentSample, p_sl, and p_ss.

Referenced by Isis::LineScanCameraGroundMap::FindFocalPlane(), Isis::LineScanCameraGroundMap::FindSpacecraftDistance(), Isis::Camera::SetImage(), Isis::VariableLineScanCameraDetectorMap::SetParent(), Isis::RadarPulseMap::SetParent(), Isis::PushFrameCameraDetectorMap::SetParent(), and Isis::LineScanCameraDetectorMap::SetParent().

void Isis::CameraDetectorMap::SetStartingDetectorLine ( const double  line  )  [inline]

Set the starting detector line.

Use this method to specify the starting detector that represents the first image line in the cube. If not set the default is 1.

Parameters:
line Starting detector line

Definition at line 90 of file CameraDetectorMap.h.

References Compute(), and p_startingDetectorSample.

void Isis::CameraDetectorMap::SetStartingDetectorSample ( const double  sample  )  [inline]

Set the starting detector sample.

Use this method to specify the starting detector that represents the first image sample in the cube. If not set the default is 1.

Parameters:
sample Starting detector sample

Definition at line 77 of file CameraDetectorMap.h.

References Compute(), and p_startingDetectorSample.

Referenced by Isis::Mro::CTXCamera::CTXCamera(), Isis::Mro::HiriseCamera::HiriseCamera(), Isis::Lro::LroNarrowAngleCamera::LroNarrowAngleCamera(), and Isis::Mgs::MocNarrowAngleCamera::MocNarrowAngleCamera().


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