USGS

Isis 3.0 Object Programmers' Reference

Home

Isis::LineScanCameraDetectorMap Class Reference

#include <LineScanCameraDetectorMap.h>

Inheritance diagram for Isis::LineScanCameraDetectorMap:

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

Collaboration graph
[legend]
List of all members.

Detailed Description

Convert between parent image coordinates and detector coordinates.

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

See also:
Camera

For internal use only.

History:
2005-02-09 Jeff Anderson Original version
History:
2009-03-07 Debbie A. Cook Removed reference to obsolute CameraDetectorMap methods

Definition at line 46 of file LineScanCameraDetectorMap.h.

Public Member Functions

 LineScanCameraDetectorMap (Camera *parent, const double etStart, const double lineRate)
 Construct a detector map for line scan cameras.
virtual ~LineScanCameraDetectorMap ()
 Destructor.
void SetStartTime (const double etStart)
 Reset the starting ephemeris time.
void SetLineRate (const double lineRate)
 Reset the line rate.
double LineRate () const
 Return the time in seconds between scan lines.
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.

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 Attributes

double p_etStart
 Starting time at the top of the 1st parent line.
double p_lineRate
 iTime between lines in parent cube


Constructor & Destructor Documentation

Isis::LineScanCameraDetectorMap::LineScanCameraDetectorMap ( Camera parent,
const double  etStart,
const double  lineRate 
) [inline]

Construct a detector map for line scan cameras.

Parameters:
parent The parent camera model for the detector map
etStart starting ephemeris time in seconds at the top of the first line
lineRate the time in seconds between lines

Definition at line 56 of file LineScanCameraDetectorMap.h.

References p_etStart, and p_lineRate.

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

Destructor.

Definition at line 64 of file LineScanCameraDetectorMap.h.


Member Function Documentation

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

Return detector line.

Definition at line 67 of file CameraDetectorMap.h.

References Isis::CameraDetectorMap::p_detectorLine.

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

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

Return detector sample.

Definition at line 64 of file CameraDetectorMap.h.

References Isis::CameraDetectorMap::p_detectorSample.

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

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

Return the time in seconds between scan lines.

Reimplemented from Isis::CameraDetectorMap.

Definition at line 89 of file LineScanCameraDetectorMap.h.

References p_lineRate.

Referenced by Isis::LineScanCameraGroundMap::FindFocalPlane(), and Isis::LineScanCameraSkyMap::SetSky().

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

Return scaling factor for computing line resolution.

Definition at line 129 of file CameraDetectorMap.h.

References Isis::CameraDetectorMap::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, inherited]

Return parent line.

Definition at line 61 of file CameraDetectorMap.h.

References Isis::CameraDetectorMap::p_parentLine.

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

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

Return parent sample.

Definition at line 58 of file CameraDetectorMap.h.

References Isis::CameraDetectorMap::p_parentSample.

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

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

Return scaling factor for computing sample resolution.

Definition at line 124 of file CameraDetectorMap.h.

References Isis::CameraDetectorMap::p_detectorSampleSumming.

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

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

Compute parent position from a detector coordinate.

This method will compute a parent sample given a detector coordinate. The parent line will be computed using the the time in the parent camera

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

Reimplemented from Isis::CameraDetectorMap.

Reimplemented in Isis::VariableLineScanCameraDetectorMap, and Isis::Mgs::MocWideAngleDetectorMap.

Definition at line 39 of file LineScanCameraDetectorMap.cpp.

References Isis::Spice::EphemerisTime(), Isis::CameraDetectorMap::p_camera, p_etStart, p_lineRate, Isis::CameraDetectorMap::p_parentLine, and Isis::CameraDetectorMap::SetDetector().

Referenced by Isis::Mgs::MocWideAngleDetectorMap::SetDetector().

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

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 Isis::CameraDetectorMap::Compute(), and Isis::CameraDetectorMap::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, inherited]

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 Isis::CameraDetectorMap::Compute(), and Isis::CameraDetectorMap::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().

void Isis::LineScanCameraDetectorMap::SetLineRate ( const double  lineRate  )  [inline]

Reset the line rate.

Use this method to reset the time between lines. Usually this will not need to be done unless the rate changes between bands.

Parameters:
lineRate the time in seconds between lines

Definition at line 86 of file LineScanCameraDetectorMap.h.

References p_lineRate.

Referenced by Isis::VariableLineScanCameraDetectorMap::SetDetector(), and Isis::VariableLineScanCameraDetectorMap::SetParent().

bool Isis::LineScanCameraDetectorMap::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. The parent line will be used to set the appropriate time in the parent camera.

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

Reimplemented from Isis::CameraDetectorMap.

Reimplemented in Isis::VariableLineScanCameraDetectorMap, and Isis::Mgs::MocWideAngleDetectorMap.

Definition at line 58 of file LineScanCameraDetectorMap.cpp.

References Isis::CameraFocalPlaneMap::DetectorLineOffset(), Isis::Camera::FocalPlaneMap(), Isis::CameraDetectorMap::p_camera, Isis::CameraDetectorMap::p_detectorLine, p_etStart, p_lineRate, Isis::Sensor::SetEphemerisTime(), and Isis::CameraDetectorMap::SetParent().

Referenced by Isis::Mgs::MocWideAngleDetectorMap::SetParent().

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

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 Isis::CameraDetectorMap::Compute(), and Isis::CameraDetectorMap::p_startingDetectorSample.

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

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 Isis::CameraDetectorMap::Compute(), and Isis::CameraDetectorMap::p_startingDetectorSample.

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

void Isis::LineScanCameraDetectorMap::SetStartTime ( const double  etStart  )  [inline]

Reset the starting ephemeris time.

Use this method to reset the starting time of the top edge of the first line in the parent image. That is the time, prior to cropping, scaling, or padding. Usually this will not need to be done unless the time changes between bands.

Parameters:
etStart starting ephemeris time in seconds

Definition at line 76 of file LineScanCameraDetectorMap.h.

References p_etStart.

Referenced by Isis::Odyssey::ThemisIrCamera::SetBand().


Member Data Documentation

double Isis::LineScanCameraDetectorMap::p_etStart [private]

Starting time at the top of the 1st parent line.

Definition at line 96 of file LineScanCameraDetectorMap.h.

Referenced by LineScanCameraDetectorMap(), SetDetector(), SetParent(), and SetStartTime().

double Isis::LineScanCameraDetectorMap::p_lineRate [private]

iTime between lines in parent cube

Definition at line 97 of file LineScanCameraDetectorMap.h.

Referenced by LineRate(), LineScanCameraDetectorMap(), SetDetector(), SetLineRate(), and SetParent().


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