isce3  0.1.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Pages
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
isce3::product::RadarGridParameters Class Reference

Public Member Functions

 RadarGridParameters ()
 Default constructor.
 
 RadarGridParameters (const isce3::product::Product &product, char frequency= 'A')
 Constructor with a product. More...
 
 RadarGridParameters (const isce3::product::Swath &swath, isce3::core::LookSide lookSide)
 Constructor with a swath. More...
 
 RadarGridParameters (const isce3::core::Metadata &meta, const isce3::core::DateTime &refEpoch)
 Constructor from an isce3::core::Metadata object. More...
 
 RadarGridParameters (double sensingStart, double wavelength, double prf, double startingRange, double rangePixelSpacing, isce3::core::LookSide lookSide, size_t length, size_t width, isce3::core::DateTime refEpoch)
 Constructor from individual components and values. More...
 
 RadarGridParameters (const RadarGridParameters &rgparam)
 Copy constructor. More...
 
RadarGridParametersoperator= (const RadarGridParameters &rgparam)
 Assignment operator. More...
 
isce3::core::LookSide lookSide () const
 Get the look direction.
 
void lookSide (isce3::core::LookSide side)
 Set look direction.
 
void lookSide (const std::string &)
 Set look direction from a string. More...
 
const isce3::core::DateTimerefEpoch () const
 Get reference epoch DateTime.
 
void refEpoch (const isce3::core::DateTime &epoch)
 Set reference epoch DateTime. More...
 
double sensingStart () const
 Get sensing start time in seconds since reference epoch.
 
void sensingStart (const double &t)
 Set sensing start time in seconds since reference epoch.
 
double wavelength () const
 Get radar wavelength in meters.
 
void wavelength (const double &t)
 Set radar wavelength in meters.
 
double prf () const
 Get pulse repetition frequency in Hz - inverse of azimuth time interval.
 
void prf (const double &t)
 Set pulse repetition frequency in Hz - inverse of azimuth time interval.
 
double azimuthTimeInterval () const
 Get azimuth time interval in seconds.
 
double startingRange () const
 Get starting slant range in meters.
 
void startingRange (const double &r)
 Set starting slant range in meters.
 
double rangePixelSpacing () const
 Get slant range pixel spacing in meters.
 
void rangePixelSpacing (const double &t)
 Set slant range pixel spacing in meters.
 
size_t length () const
 Get radar grid length.
 
void length (const size_t &t)
 Set radar grid length.
 
size_t width () const
 Get radar grid width.
 
void width (const size_t &t)
 Set radar grid width.
 
size_t size () const
 Get total number of radar grid elements.
 
double sensingStop () const
 Get sensing stop time in seconds since reference epoch.
 
double sensingMid () const
 Get sensing mid time in seconds.
 
double sensingTime (double line) const
 Get sensing time for a given line (zero-index row)
 
isce3::core::DateTime sensingDateTime (double line) const
 Get a sensing DateTime for a given line (zero-index row)
 
double endingRange () const
 Get ending slant range.
 
double midRange () const
 Get middle slant range.
 
double slantRange (double sample) const
 Get slant range for a given sample (zero-index column)
 
RadarGridParameters offsetAndResize (double yoff, double xoff, size_t ysize, size_t xsize) const
 Crop/ Expand while keeping the spacing the same with top left offset and size.
 
RadarGridParameters multilook (size_t azlooks, size_t rglooks) const
 Multilook.
 

Protected Member Functions

void validate () const
 Validate parameters of data structure.
 

Protected Attributes

isce3::core::LookSide _lookSide
 Left or right looking geometry indicator.
 
double _sensingStart
 Sensing start time.
 
double _wavelength
 Imaging wavelength.
 
double _prf
 PRF.
 
double _startingRange
 Slant range to center of first pixel.
 
double _rangePixelSpacing
 Slant range pixel spacing.
 
size_t _rlength
 Number of lines in the image.
 
size_t _rwidth
 Number of samples in the image.
 
isce3::core::DateTime _refEpoch
 Reference epoch for time tags.
 

Constructor & Destructor Documentation

isce3::product::RadarGridParameters::RadarGridParameters ( const isce3::product::Product product,
char  frequency = 'A' 
)

Constructor with a product.

Parameters
[in]productInput Product
[in]frequencyFrequency designation
isce3::product::RadarGridParameters::RadarGridParameters ( const isce3::product::Swath swath,
isce3::core::LookSide  lookSide 
)

Constructor with a swath.

Parameters
[in]swathInput swath
[in]lookSideIndicate left (+1) or right (-1)
isce3::product::RadarGridParameters::RadarGridParameters ( const isce3::core::Metadata meta,
const isce3::core::DateTime refEpoch 
)
inline

Constructor from an isce3::core::Metadata object.

Parameters
[in]metaisce3::core::Metadata object
[in]refEpochReference epoch date
isce3::product::RadarGridParameters::RadarGridParameters ( double  sensingStart,
double  wavelength,
double  prf,
double  startingRange,
double  rangePixelSpacing,
isce3::core::LookSide  lookSide,
size_t  length,
size_t  width,
isce3::core::DateTime  refEpoch 
)
inline

Constructor from individual components and values.

isce3::product::RadarGridParameters::RadarGridParameters ( const RadarGridParameters rgparams)
inline

Copy constructor.

Parameters
[in]rgparamRadarGridParameters object

Member Function Documentation

void isce3::product::RadarGridParameters::lookSide ( const std::string &  inputLook)
inline

Set look direction from a string.

Parameters
[in]lookString representation of look side
isce3::product::RadarGridParameters & isce3::product::RadarGridParameters::operator= ( const RadarGridParameters rgparams)
inline

Assignment operator.

Parameters
[in]rgparamRadarGridParameters object
void isce3::product::RadarGridParameters::refEpoch ( const isce3::core::DateTime epoch)
inline

Set reference epoch DateTime.

Other dependent parameters like sensingStart are not modified. Use with caution.


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

Generated for ISCE3.0 by doxygen 1.8.5.