isce3 0.25.0
Loading...
Searching...
No Matches
isce3::cuda::product::ViewSubSwaths Class Reference

View subswaths class. More...

#include <SubSwaths.h>

Inheritance diagram for isce3::cuda::product::ViewSubSwaths:
isce3::cuda::product::BaseSubSwaths

Public Member Functions

CUDA_HOST ViewSubSwaths ()
 Default constructor uninitialized with an owner needed for test harness.
 
CUDA_HOST ViewSubSwaths (OwnerSubSwaths &owner_subswaths)
 Constructor to create ViewSubSwaths from an OwnerSubSwaths object.
 
CUDA_DEV bool contains (const int index_aztime, const int index_srange) const
 Check if a specific index is contained within the subswaths.
 
- Public Member Functions inherited from isce3::cuda::product::BaseSubSwaths
CUDA_HOST BaseSubSwaths (const isce3::product::SubSwaths &cpu_subswaths)
 Construct with an existing CPU subswath object.
 
CUDA_HOST BaseSubSwaths (const size_t length, const size_t width, unsigned int n_subswaths)
 Construct a BaseSubSwaths object with specified parameters.
 
CUDA_HOSTDEV size_t length () const
 Get the length of the radar grid.
 
CUDA_HOSTDEV size_t width () const
 Get the width of the radar grid.
 
CUDA_HOSTDEV unsigned int n_subswaths () const
 Get the number of subswaths.
 

Additional Inherited Members

- Protected Attributes inherited from isce3::cuda::product::BaseSubSwaths
size_t _length = 0
 
size_t _width = 0
 
unsigned int _n_subswaths = 0
 

Detailed Description

View subswaths class.

Only created from OwnerSubSwaths objects.Each subswath device vector in the OwnerSubSwaths is viewable as a pointer to the device vector's data on the GPU.

Constructor & Destructor Documentation

◆ ViewSubSwaths() [1/2]

CUDA_HOST isce3::cuda::product::ViewSubSwaths::ViewSubSwaths ( )
inline

Default constructor uninitialized with an owner needed for test harness.

Not to be used by ordinary code.

◆ ViewSubSwaths() [2/2]

__host__ isce3::cuda::product::ViewSubSwaths::ViewSubSwaths ( OwnerSubSwaths & owner_subswaths)

Constructor to create ViewSubSwaths from an OwnerSubSwaths object.

Parameters
[in]owner_subswathsThe OwnerSubSwaths object to create views from.

Member Function Documentation

◆ contains()

CUDA_DEV bool isce3::cuda::product::ViewSubSwaths::contains ( const int index_aztime,
const int index_srange ) const
inline

Check if a specific index is contained within the subswaths.

Parameters
[in]index_aztimeThe azimuth time index to check.
[in]index_srangeThe slant range index to check.
Returns
True if the index is contained within any subswath, false otherwise. If no subswaths, automatically return true.

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

Generated for ISCE3.0 by doxygen 1.13.2.