|
Isis 3.0 Object Programmers' Reference |
Home |
Convert between parent image coordinates and detector coordinates. More...
#include <VariableLineScanCameraDetectorMap.h>
Public Member Functions | |
| VariableLineScanCameraDetectorMap (Camera *parent, std::vector< LineRateChange > &lineRates) | |
| Constructs a VariableLineScanCameraDetectorMap. | |
| virtual | ~VariableLineScanCameraDetectorMap () |
| 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. | |
| 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. | |
| double | StartTime () const |
| Return the starting time at the top edge of the first line in the parent image. | |
| double | AdjustedStartingSample () const |
| Return the starting detector sample adjusted for summation. | |
| double | AdjustedStartingLine () const |
| Return the starting detector line adjusted for summation. | |
| 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 | |
| Camera * | p_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 | |
| std::vector< LineRateChange > & | p_lineRates |
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.
Definition at line 49 of file VariableLineScanCameraDetectorMap.h.
| Isis::VariableLineScanCameraDetectorMap::VariableLineScanCameraDetectorMap | ( | Camera * | parent, |
| std::vector< LineRateChange > & | lineRates | ||
| ) |
Constructs a VariableLineScanCameraDetectorMap.
| parent | The camera |
| p_lineRates | This should be a vector with an entry for every scan rate change in it. The pair consists of the line number and ET of the changed time; the first entry should be line 1 and the last entry should be one line past the end of the image. See HrscCamera for an example. |
Definition at line 29 of file VariableLineScanCameraDetectorMap.cpp.
| virtual Isis::VariableLineScanCameraDetectorMap::~VariableLineScanCameraDetectorMap | ( | ) | [inline, virtual] |
Destructor.
Definition at line 64 of file VariableLineScanCameraDetectorMap.h.
| double Isis::CameraDetectorMap::AdjustedStartingLine | ( | ) | const [inherited] |
Return the starting detector line adjusted for summation.
Definition at line 93 of file CameraDetectorMap.cpp.
| double Isis::CameraDetectorMap::AdjustedStartingSample | ( | ) | const [inherited] |
Return the starting detector sample adjusted for summation.
Definition at line 88 of file CameraDetectorMap.cpp.
| double Isis::CameraDetectorMap::DetectorLine | ( | ) | const [inline, inherited] |
Return detector line.
Definition at line 87 of file CameraDetectorMap.h.
Referenced by Isis::Camera::SetImage().
| double Isis::CameraDetectorMap::DetectorSample | ( | ) | const [inline, inherited] |
Return detector sample.
Definition at line 82 of file CameraDetectorMap.h.
Referenced by Isis::Camera::SetImage().
| double Isis::LineScanCameraDetectorMap::LineRate | ( | ) | const [inline, virtual, inherited] |
Return the time in seconds between scan lines.
Reimplemented from Isis::CameraDetectorMap.
Definition at line 97 of file LineScanCameraDetectorMap.h.
References Isis::LineScanCameraDetectorMap::p_lineRate.
Referenced by Isis::LineScanCameraSkyMap::SetSky().
| virtual double Isis::CameraDetectorMap::LineScaleFactor | ( | ) | const [inline, virtual, inherited] |
Return scaling factor for computing line resolution.
Definition at line 151 of file CameraDetectorMap.h.
Referenced by Isis::PushFrameCameraGroundMap::FindDistance(), Isis::Camera::LineResolution(), Isis::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 77 of file CameraDetectorMap.h.
Referenced by Isis::Camera::RawFocalPlanetoImage(), and Isis::Camera::SetRightAscensionDeclination().
| double Isis::CameraDetectorMap::ParentSample | ( | ) | const [inline, inherited] |
Return parent sample.
Definition at line 72 of file CameraDetectorMap.h.
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 146 of file CameraDetectorMap.h.
Referenced by Isis::Camera::SampleResolution().
| bool Isis::VariableLineScanCameraDetectorMap::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
| sample | Sample number in the detector |
| line | Line number in the detector |
Reimplemented from Isis::LineScanCameraDetectorMap.
Definition at line 45 of file VariableLineScanCameraDetectorMap.cpp.
References Isis::iTime::Et(), Isis::CameraDetectorMap::SetDetector(), Isis::LineScanCameraDetectorMap::SetLineRate(), and Isis::Spice::time().
| 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.
| summing | Line summing mode |
Definition at line 140 of file CameraDetectorMap.h.
References Isis::CameraDetectorMap::Compute().
Referenced by Isis::CrismCamera::CrismCamera(), Isis::DawnFcCamera::DawnFcCamera(), Isis::HiriseCamera::HiriseCamera(), Isis::IssNACamera::IssNACamera(), Isis::IssWACamera::IssWACamera(), Isis::LroWideAngleCamera::LroWideAngleCamera(), Isis::MarciCamera::MarciCamera(), Isis::MdisCamera::MdisCamera(), Isis::MocNarrowAngleCamera::MocNarrowAngleCamera(), Isis::MocWideAngleCamera::MocWideAngleCamera(), Isis::SsiCamera::SsiCamera(), Isis::ThemisIrCamera::ThemisIrCamera(), and Isis::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.
| summing | Sample summing mode |
Definition at line 126 of file CameraDetectorMap.h.
References Isis::CameraDetectorMap::Compute().
Referenced by Isis::ApolloPanoramicCamera::ApolloPanoramicCamera(), Isis::CrismCamera::CrismCamera(), Isis::CTXCamera::CTXCamera(), Isis::DawnFcCamera::DawnFcCamera(), Isis::HiriseCamera::HiriseCamera(), Isis::HrscCamera::HrscCamera(), Isis::IssNACamera::IssNACamera(), Isis::IssWACamera::IssWACamera(), Isis::LroNarrowAngleCamera::LroNarrowAngleCamera(), Isis::LroWideAngleCamera::LroWideAngleCamera(), Isis::MarciCamera::MarciCamera(), Isis::MdisCamera::MdisCamera(), Isis::MocNarrowAngleCamera::MocNarrowAngleCamera(), Isis::MocWideAngleCamera::MocWideAngleCamera(), Isis::SsiCamera::SsiCamera(), Isis::ThemisIrCamera::ThemisIrCamera(), and Isis::ThemisVisCamera::ThemisVisCamera().
| void Isis::LineScanCameraDetectorMap::SetLineRate | ( | const double | lineRate | ) | [inline, inherited] |
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.
| lineRate | the time in seconds between lines |
Definition at line 92 of file LineScanCameraDetectorMap.h.
References Isis::LineScanCameraDetectorMap::p_lineRate.
Referenced by SetDetector(), and SetParent().
| bool Isis::VariableLineScanCameraDetectorMap::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.
| sample | Sample number in the parent image |
| line | Line number in the parent image |
Reimplemented from Isis::LineScanCameraDetectorMap.
Definition at line 89 of file VariableLineScanCameraDetectorMap.cpp.
References Isis::CameraFocalPlaneMap::DetectorLineOffset(), Isis::Camera::FocalPlaneMap(), Isis::LineScanCameraDetectorMap::SetLineRate(), Isis::CameraDetectorMap::SetParent(), and Isis::Sensor::setTime().
| 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.
| line | Starting detector line |
Definition at line 112 of file CameraDetectorMap.h.
References Isis::CameraDetectorMap::Compute().
Referenced by Isis::MdisCamera::MdisCamera().
| 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.
| sample | Starting detector sample |
Definition at line 99 of file CameraDetectorMap.h.
References Isis::CameraDetectorMap::Compute().
Referenced by Isis::ApolloPanoramicCamera::ApolloPanoramicCamera(), Isis::CTXCamera::CTXCamera(), Isis::HiriseCamera::HiriseCamera(), Isis::LroNarrowAngleCamera::LroNarrowAngleCamera(), Isis::LroWideAngleCamera::LroWideAngleCamera(), Isis::MdisCamera::MdisCamera(), Isis::MocNarrowAngleCamera::MocNarrowAngleCamera(), and Isis::MocWideAngleCamera::MocWideAngleCamera().
| void Isis::LineScanCameraDetectorMap::SetStartTime | ( | const double | etStart | ) | [inline, inherited] |
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.
| etStart | starting ephemeris time in seconds |
Definition at line 80 of file LineScanCameraDetectorMap.h.
References Isis::LineScanCameraDetectorMap::p_etStart.
Referenced by Isis::ThemisIrCamera::SetBand().
| double Isis::LineScanCameraDetectorMap::StartTime | ( | ) | const [inherited] |
Return the starting time at the top edge of the first line in the parent image.
Definition at line 70 of file LineScanCameraDetectorMap.cpp.
References Isis::LineScanCameraDetectorMap::p_etStart.