Isis Developer Reference
|
General purpose Embree ray tracing model. More...
#include <EmbreeShapeModel.h>
Public Member Functions | |
EmbreeShapeModel () | |
Default constructor sets type to a TIN. More... | |
EmbreeShapeModel (Target *target, Pvl &pvl, EmbreeTargetManager *targetManager) | |
Constructor provided for instantiation from an ISIS cube. More... | |
EmbreeShapeModel (Target *target, const QString &shapefile, EmbreeTargetManager *targetManager) | |
Constructor provided for instantiation from a file. More... | |
virtual | ~EmbreeShapeModel () |
Destructor that notifies the target shape manager that the target shape is no longer in use. More... | |
virtual bool | intersectSurface (std::vector< double > observerPos, std::vector< double > lookDirection) |
This method computes an intercept point given an observer location and look direction using the Embree model. More... | |
virtual bool | intersectSurface (const Latitude &lat, const Longitude &lon, const std::vector< double > &observerPos, const bool &backCheck=true) |
Compute intersection of surface vector direction from observer with occulusion. More... | |
virtual bool | intersectSurface (const SurfacePoint &surfpt, const std::vector< double > &observerPos, const bool &backCheck=true) |
Compute intersection of surface point from observer with occulusion. More... | |
virtual void | clearSurfacePoint () |
Flag that the ShapeModel does not have a surface point or normal. More... | |
virtual bool | isDEM () const |
Indicates that this shape model is not from a DEM. More... | |
double | getTolerance () const |
Get the tolerance used when checking if the stored surface point is visible. More... | |
void | setTolerance (const double &tolerance) |
Set the tolerance used when checking if the stored surface point is visible. More... | |
virtual void | calculateDefaultNormal () |
Return the surface normal of the ellipsoid as the default. More... | |
virtual void | calculateLocalNormal (QVector< double * > cornerNeighborPoints) |
Compute the normal for a local region of surface points. More... | |
virtual void | calculateSurfaceNormal () |
Return the surface normal of the ellipsoid. More... | |
QVector< double > | ellipsoidNormal () |
Compute the true surface normal vector of an ellipsoid. More... | |
virtual double | incidenceAngle (const std::vector< double > &uB) |
Computes and returns incidence angle, in degrees, given the illuminator position. More... | |
virtual Distance | localRadius (const Latitude &lat, const Longitude &lon) |
Determine radius at a given lat/lon grid point. More... | |
virtual bool | isVisibleFrom (const std::vector< double > observerPos, const std::vector< double > lookDirection) |
Check if the current internalized surface point is visible from an observer position and look direction. More... | |
void | Initialize () |
Initializes the ShapeModel private variables. More... | |
SurfacePoint * | surfaceIntersection () const |
Returns the surface intersection for this ShapeModel. More... | |
bool | hasIntersection () |
Returns intersection status. More... | |
bool | hasNormal () const |
Returns surface point normal status. More... | |
virtual double | emissionAngle (const std::vector< double > &sB) |
Computes and returns emission angle, in degrees, given the observer position. More... | |
virtual double | phaseAngle (const std::vector< double > &sB, const std::vector< double > &uB) |
Computes and returns phase angle, in degrees, given the positions of the observer and illuminator. More... | |
QString | name () const |
Gets the shape name. More... | |
void | setHasIntersection (bool b) |
Sets the flag to indicate whether this ShapeModel has an intersection. More... | |
virtual void | setSurfacePoint (const SurfacePoint &surfacePoint) |
Set surface intersection point. More... | |
std::vector< double > | normal () |
Returns the local surface normal at the current intersection point. More... | |
Protected Member Functions | |
void | setNormal (const std::vector< double >) |
Sets the normal for the currect intersection point. More... | |
void | setNormal (const double a, const double b, const double c) |
Sets the normal for the currect intersection point. More... | |
void | setName (QString name) |
Sets the shape name. More... | |
void | calculateEllipsoidalSurfaceNormal () |
Calculates the ellipsoidal surface normal. More... | |
bool | hasEllipsoidIntersection () |
Returns the status of the ellipsoid model intersection. More... | |
bool | intersectEllipsoid (const std::vector< double > observerPosRelativeToTarget, const std::vector< double > &observerLookVectorToTarget) |
Finds the intersection point on the ellipsoid model using the given position of the observer (spacecraft) and direction vector from the observer to the target (body). More... | |
bool | hasValidTarget () const |
Returns the status of the target. More... | |
std::vector< Distance > | targetRadii () const |
Returns the radii of the body in km. More... | |
void | setHasNormal (bool status) |
Sets the flag to indicate whether this ShapeModel has a surface normal. More... | |
double | resolution () |
Convenience method to get pixel resolution (m/pix) at current intersection point. More... | |
General purpose Embree ray tracing model.
Isis::EmbreeShapeModel::EmbreeShapeModel | ( | ) |
Default constructor sets type to a TIN.
References Isis::ShapeModel::setName().
Isis::EmbreeShapeModel::EmbreeShapeModel | ( | Target * | target, |
Pvl & | pvl, | ||
EmbreeTargetManager * | targetManager | ||
) |
Constructor provided for instantiation from an ISIS cube.
This constructor is typically used for and ISIS cube that has been initialized by spiceinit. The target shape file will be read from the Pvl label.
target | Target object describing the observed body |
pvl | ISIS Cube label. The target shape file will be extracted from the Kernels group |
targetManager | The target shape manager that will manage the target shape |
References _FILEINFO_, Isis::EmbreeTargetManager::create(), Isis::PvlObject::findGroup(), Isis::PvlContainer::hasKeyword(), Isis::ShapeModel::setName(), Isis::PvlObject::Traverse, and Isis::IException::User.
Isis::EmbreeShapeModel::EmbreeShapeModel | ( | Target * | target, |
const QString & | shapefile, | ||
EmbreeTargetManager * | targetManager | ||
) |
Constructor provided for instantiation from a file.
target | Target object describing the observed body |
shapefile | The targe shape file to use |
targetManager | The target shape manager that will manage the target shape |
References _FILEINFO_, Isis::EmbreeTargetManager::create(), Isis::ShapeModel::setName(), and Isis::IException::User.
|
virtual |
Destructor that notifies the target shape manager that the target shape is no longer in use.
References Isis::EmbreeTargetManager::free().
|
virtual |
Return the surface normal of the ellipsoid as the default.
Implements Isis::ShapeModel.
References calculateSurfaceNormal().
Referenced by incidenceAngle().
|
protectedinherited |
Calculates the ellipsoidal surface normal.
References _FILEINFO_.
|
virtual |
Compute the normal for a local region of surface points.
This method will calculate the surface normal of an assumed very local region of points. This method is provided to fullfil the specs of the ShapeModel class but this approach is not the most efficent means to accomplish this for a pre-exising intercept point. See setLocalNormalFromIntercept() for this.
The ShapeModel class makes the assumption that the four pixel corners of the center intercept point forms a plane from which a surface normal can be computed. For the Naif DSK plate model, we have already identified the plate (see m_intercept) from the DSK plate model (m_model) of the intercept point that provides it directly. That is what setLocalNormalFromIntercept() provides.
So, this implementation will compute the centroid of the neighboring points and make a determination if it intercepts the current intercept plate as defined by m_intercept - if it is valid. If it does not exist or does not intercept the plate, a new intercept point is computed and returned here.
neighborPoints | Input body-fixed points to compute normal for |
Implements Isis::ShapeModel.
References _FILEINFO_, Isis::ShapeModel::hasIntersection(), and Isis::IException::Programmer.
|
virtual |
Return the surface normal of the ellipsoid.
Implements Isis::ShapeModel.
References ellipsoidNormal(), and Isis::ShapeModel::setNormal().
Referenced by calculateDefaultNormal().
|
virtual |
Flag that the ShapeModel does not have a surface point or normal.
Reimplemented from Isis::ShapeModel.
References Isis::ShapeModel::clearSurfacePoint(), and Isis::ShapeModel::setHasNormal().
Referenced by intersectSurface().
QVector< double > Isis::EmbreeShapeModel::ellipsoidNormal | ( | ) |
Compute the true surface normal vector of an ellipsoid.
This routine is used instead of the one provided by the ShapeModel implementation. This is primarly because ShapeModel::calculateEllipsoidalSurfaceNormal() it is only suitable for a spheroid. This implementation is intended for irregular bodies so we expect triaxial ellipsoids.
References _FILEINFO_, Isis::NaifStatus::CheckErrors(), Isis::ShapeModel::hasIntersection(), Isis::ShapeModel::hasValidTarget(), Isis::IException::Programmer, Isis::ShapeModel::surfaceIntersection(), Isis::ShapeModel::targetRadii(), and Isis::SurfacePoint::ToNaifArray().
Referenced by calculateSurfaceNormal().
|
virtualinherited |
Computes and returns emission angle, in degrees, given the observer position.
Emission Angle: The angle between the surface normal vector at the intersection point and the vector from the intersection point to the observer (usually the spacecraft). The emission angle varies from 0 degrees when the observer is viewing the sub-spacecraft point (nadir viewing) to 90 degrees when the intercept is tangent to the surface of the target body. Thus, higher values of emission angle indicate more oblique viewing of the target.
observerBodyFixedPosition | Three dimensional position of the observer, in the coordinate system of the target body. |
Reimplemented in Isis::PlaneShape.
References Isis::RAD2DEG.
Referenced by Isis::CSMCamera::EmissionAngle(), and Isis::Sensor::EmissionAngle().
double Isis::EmbreeShapeModel::getTolerance | ( | ) | const |
Get the tolerance used when checking if the stored surface point is visible.
Referenced by isVisibleFrom().
|
protectedinherited |
Returns the status of the ellipsoid model intersection.
|
inherited |
Returns intersection status.
Referenced by Isis::DemShape::calculateDefaultNormal(), Isis::BulletShapeModel::calculateLocalNormal(), Isis::EllipsoidShape::calculateLocalNormal(), calculateLocalNormal(), Isis::NaifDskShape::calculateLocalNormal(), Isis::BulletShapeModel::ellipsoidNormal(), ellipsoidNormal(), Isis::NaifDskShape::ellipsoidNormal(), Isis::Camera::GetLocalNormal(), Isis::Sensor::HasSurfaceIntersection(), Isis::BulletShapeModel::intersectSurface(), Isis::DemShape::intersectSurface(), intersectSurface(), Isis::EquatorialCylindricalShape::intersectSurface(), Isis::CSMCamera::SetGround(), Isis::BulletShapeModel::setLocalNormalFromIntercept(), and Isis::NaifDskShape::setLocalNormalFromIntercept().
|
inherited |
Returns surface point normal status.
Referenced by Isis::Camera::GetLocalNormal(), and incidenceAngle().
|
protectedinherited |
Returns the status of the target.
If it is NULL, this method returns false.
Referenced by Isis::BulletShapeModel::ellipsoidNormal(), ellipsoidNormal(), and Isis::NaifDskShape::ellipsoidNormal().
|
virtual |
Computes and returns incidence angle, in degrees, given the illuminator position.
The surface normal vector is calculated using an ellipsoid, not the local normal of the actual target shape.
Incidence Angle: The angle between the surface normal vector at the intersection point and the vector from the intersection point to the illuminator (usually the sun).
Note: this method does not use the surface model.
illuminatorBodyFixedPosition | Three dimensional position for the illuminator, in the body-fixed coordinate system. |
Reimplemented from Isis::ShapeModel.
References calculateDefaultNormal(), Isis::ShapeModel::hasNormal(), Isis::ShapeModel::incidenceAngle(), Isis::ShapeModel::normal(), and Isis::ShapeModel::setNormal().
|
inherited |
Initializes the ShapeModel private variables.
|
protectedinherited |
Finds the intersection point on the ellipsoid model using the given position of the observer (spacecraft) and direction vector from the observer to the target (body).
observerBodyFixedPosition | Three dimensional position of the observer, in the coordinate system of the target body. |
observerLookVectorToTarget | Three dimensional direction vector from the observer to the target. |
Referenced by Isis::DemShape::intersectSurface(), and Isis::EllipsoidShape::intersectSurface().
|
virtual |
Compute intersection of surface vector direction from observer with occulusion.
This method computes a surface intersection point at a given latitude and longitude. All surface points at that latitude and longitude are collected and then the intersect that is non-occluded and closest to the observer is saved. The unit surface normal is also saved.
If occlusion is not checked, then the closest intersection to the observer is saved along with the unit surface normal.
lat | The latitude of the surface intersection |
lon | The longitude of the surface intersection |
observerPos | The position of the observer for occlusion checks |
backCheck | If occlusion should be checked |
Reimplemented from Isis::ShapeModel.
References clearSurfacePoint(), Isis::ShapeModel::hasIntersection(), Isis::RTCOcclusionRay::ignorePrimID, Isis::EmbreeTargetShape::intersectRay(), Isis::EmbreeTargetShape::isOccluded(), Isis::RTCMultiHitRay::lastHit, Isis::LinearAlgebra::magnitude(), Isis::LinearAlgebra::normalize(), and Isis::LinearAlgebra::vector().
|
virtual |
Compute intersection of surface point from observer with occulusion.
Compute the intersection point closest to a surface point. If occlusion is checked, then the intersection that is both closest to the surface point and non-occluded is saved. If occlusion is not checked, then the intersection closest to the surface point is saved.
The unit surface normal is also saved when an intersection is saved.
surfpt | Surface intercept point |
observerPos | Observer to check occlusion |
backCheck | If occlusion should be checked |
Reimplemented from Isis::ShapeModel.
References clearSurfacePoint(), Isis::ShapeModel::hasIntersection(), Isis::RTCOcclusionRay::ignorePrimID, Isis::EmbreeTargetShape::intersectRay(), Isis::EmbreeTargetShape::isOccluded(), Isis::RTCMultiHitRay::lastHit, Isis::LinearAlgebra::magnitude(), Isis::LinearAlgebra::normalize(), Isis::SurfacePoint::ToNaifArray(), and Isis::LinearAlgebra::vector().
|
virtual |
This method computes an intercept point given an observer location and look direction using the Embree model.
This also saves the surface normal.
observerPos | Position of observer in body-fixed kilometers |
lookDirection | Unit look direction from the observer |
Implements Isis::ShapeModel.
References clearSurfacePoint(), Isis::EmbreeTargetShape::getHitInformation(), Isis::ShapeModel::hasIntersection(), Isis::EmbreeTargetShape::intersectRay(), Isis::RTCMultiHitRay::lastHit, and Isis::ShapeModel::setHasIntersection().
|
virtual |
Indicates that this shape model is not from a DEM.
Since this method returns false for this class, the Camera class will not calculate the local normal using neighbor points.
Implements Isis::ShapeModel.
|
virtual |
Check if the current internalized surface point is visible from an observer position and look direction.
A new intersection is calculated using the observer and look direction. If, the distance between the surface point and new intersection is less than the tolerance, then the surface point is considered to be visible.
observerPos | The position of the observer |
lookDirection | The look direction of the observer |
Reimplemented from Isis::ShapeModel.
References Isis::EmbreeTargetShape::getHitInformation(), getTolerance(), Isis::RayHitInformation::intersection, Isis::EmbreeTargetShape::intersectRay(), Isis::RTCMultiHitRay::lastHit, Isis::LinearAlgebra::magnitude(), Isis::ShapeModel::surfaceIntersection(), Isis::SurfacePoint::ToNaifArray(), and Isis::LinearAlgebra::vector().
|
virtual |
Determine radius at a given lat/lon grid point.
@NOTE this call does not update the internal state of the intercept point. Use intersectSurface(lat, lon) for that.
Implements Isis::ShapeModel.
References Isis::EmbreeTargetShape::getHitInformation(), Isis::RayHitInformation::intersection, Isis::EmbreeTargetShape::intersectRay(), Isis::Distance::Kilometers, Isis::RTCMultiHitRay::lastHit, and Isis::LinearAlgebra::magnitude().
|
inherited |
Gets the shape name.
Referenced by Isis::UniversalGroundMap::GroundRange(), Isis::VimsGroundMap::SetGround(), Isis::Camera::SetGround(), and Isis::CSMCamera::SetGround().
|
inherited |
Returns the local surface normal at the current intersection point.
Note: This method will throw an error if the normal doesn't exist. Use the hasNormal() method to verify before calling this method.
References _FILEINFO_.
Referenced by Isis::DemShape::calculateDefaultNormal(), Isis::DemShape::calculateLocalNormal(), Isis::EllipsoidShape::calculateLocalNormal(), Isis::Camera::GetLocalNormal(), incidenceAngle(), and Isis::BulletShapeModel::setLocalNormalFromIntercept().
|
virtualinherited |
Computes and returns phase angle, in degrees, given the positions of the observer and illuminator.
Phase Angle: The angle between the vector from the intersection point to the observer (usually the spacecraft) and the vector from the intersection point to the illuminator (usually the sun).
observerBodyFixedPosition | Three dimensional position of the observer, in the coordinate system of the target body. |
illuminatorBodyFixedPosition | Three dimensional position for the illuminator, in the body-fixed coordinate system. |
References Isis::RAD2DEG.
Referenced by Isis::CSMCamera::PhaseAngle(), and Isis::Sensor::PhaseAngle().
|
protectedinherited |
Convenience method to get pixel resolution (m/pix) at current intersection point.
References _FILEINFO_.
Referenced by Isis::DemShape::intersectSurface().
|
inherited |
Sets the flag to indicate whether this ShapeModel has an intersection.
b | Indicates whether there is an intersection. |
Referenced by Isis::DemShape::intersectSurface(), intersectSurface(), Isis::EquatorialCylindricalShape::intersectSurface(), Isis::PlaneShape::intersectSurface(), Isis::CSMCamera::SetGround(), and Isis::Sensor::SetLookDirection().
|
protectedinherited |
Sets the flag to indicate whether this ShapeModel has a surface normal.
b | Indicates whether there is a normal. |
Referenced by Isis::DemShape::calculateDefaultNormal(), Isis::DemShape::calculateLocalNormal(), Isis::EllipsoidShape::calculateLocalNormal(), and clearSurfacePoint().
|
protectedinherited |
Sets the shape name.
name | The name of the ShapeModel. |
Referenced by Isis::BulletShapeModel::BulletShapeModel(), Isis::DemShape::DemShape(), Isis::EllipsoidShape::EllipsoidShape(), EmbreeShapeModel(), Isis::EquatorialCylindricalShape::EquatorialCylindricalShape(), Isis::NaifDskShape::NaifDskShape(), and Isis::PlaneShape::PlaneShape().
|
protectedinherited |
Sets the normal for the currect intersection point.
Note: This method will throw an error if this ShapeModel doesn't have and intersection. Use the hasIntersection() method to verify before calling this method.
a | First coordinate value for the three dimensional surface normal. |
b | Second coordinate value for the three dimensional surface normal. |
c | Third coordinate value for the three dimensional surface normal. |
References _FILEINFO_.
|
protectedinherited |
Sets the normal for the currect intersection point.
Note: This method will throw an error if this ShapeModel doesn't have and intersection. Use the hasIntersection() method to verify before calling this method.
normal | Three dimensional surface normal vector. |
References _FILEINFO_.
Referenced by Isis::DemShape::calculateDefaultNormal(), Isis::DemShape::calculateLocalNormal(), Isis::EllipsoidShape::calculateLocalNormal(), Isis::BulletShapeModel::calculateSurfaceNormal(), calculateSurfaceNormal(), Isis::NaifDskShape::calculateSurfaceNormal(), incidenceAngle(), Isis::PlaneShape::intersectSurface(), Isis::BulletShapeModel::setLocalNormalFromIntercept(), and Isis::NaifDskShape::setLocalNormalFromIntercept().
|
virtualinherited |
Set surface intersection point.
surfacePoint | Position coordinate for the surface point. |
Reimplemented in Isis::BulletShapeModel.
Referenced by Isis::NaifDskShape::intersectSurface(), and Isis::RadarGroundMap::SetGround().
void Isis::EmbreeShapeModel::setTolerance | ( | const double & | tolerance | ) |
Set the tolerance used when checking if the stored surface point is visible.
tolerance | The new tolerance in kilometers |
Referenced by Isis::ShapeModelFactory::create().
|
inherited |
Returns the surface intersection for this ShapeModel.
Referenced by Isis::DemShape::calculateDefaultNormal(), Isis::DemShape::calculateLocalNormal(), Isis::EllipsoidShape::calculateLocalNormal(), Isis::Sensor::Coordinate(), Isis::BulletShapeModel::ellipsoidNormal(), ellipsoidNormal(), Isis::NaifDskShape::ellipsoidNormal(), Isis::PlaneShape::emissionAngle(), Isis::Sensor::GetLatitude(), Isis::Sensor::GetLongitude(), Isis::Sensor::GetSurfacePoint(), Isis::PlaneShape::incidenceAngle(), Isis::DemShape::intersectSurface(), Isis::EquatorialCylindricalShape::intersectSurface(), Isis::PlaneShape::intersectSurface(), isVisibleFrom(), Isis::Sensor::LocalRadius(), Isis::PlaneShape::localRadius(), Isis::Sensor::SlantDistance(), and Isis::Sensor::SolarDistance().
|
protectedinherited |
Returns the radii of the body in km.
The radii are obtained from the target. Note: This method will throw an error if the ShapeModel does not have a valid target. Use the hasValidTarget() method to verify before calling this method.
References _FILEINFO_.
Referenced by Isis::DemShape::calculateDefaultNormal(), Isis::EllipsoidShape::calculateLocalNormal(), Isis::BulletShapeModel::ellipsoidNormal(), ellipsoidNormal(), Isis::NaifDskShape::ellipsoidNormal(), Isis::EquatorialCylindricalShape::intersectSurface(), and Isis::EllipsoidShape::localRadius().