TSOpt::GridMaskOp Class Reference

Mask operator for grid objects. More...

#include <gridops.hh>

List of all members.

Public Member Functions

 GridMaskOp (Space< float > const &_dom, Vector< float > const &_bg, RPNT const &sw=RPNT_0, RPNT const &ew=RPNT_0, RPNT const &width=RPNT_1)
 main constructor: takes Grid defining increment window, and width parameter defining zone of smooth taper - same on all sides.
 GridMaskOp (GridMaskOp const &op)
 Copy constructor - memberwise.
 ~GridMaskOp ()
Space< float > const & getDomain () const
Space< float > const & getRange () const
ostream & write (ostream &str) const

Protected Member Functions

void apply (Vector< float > const &, Vector< float > &) const
void applyDeriv (Vector< float > const &, Vector< float > const &, Vector< float > &) const
void applyAdjDeriv (Vector< float > const &, Vector< float > const &, Vector< float > &) const
void applyDeriv2 (const Vector< float > &, const Vector< float > &, const Vector< float > &, Vector< float > &dy) const
void applyAdjDeriv2 (const Vector< float > &, const Vector< float > &, const Vector< float > &, Vector< float > &dx1) const
Operator< float > * clone () const


Detailed Description

Mask operator for grid objects.

Apply method outputs masked version of background Vector data member: thus

$ y = x outside of mask, or 0 inside mask$

Derivative and adjoint derivative are implement standard linear injection and projection operators.

Definition at line 91 of file gridops.hh.


Constructor & Destructor Documentation

TSOpt::GridMaskOp::GridMaskOp ( Space< float > const &  _dom,
Vector< float > const &  _bg,
RPNT const &  sw = RPNT_0,
RPNT const &  ew = RPNT_0,
RPNT const &  width = RPNT_1 
)

main constructor: takes Grid defining increment window, and width parameter defining zone of smooth taper - same on all sides.

TSOpt::GridMaskOp::GridMaskOp ( GridMaskOp const &  op  ) 

Copy constructor - memberwise.

Definition at line 134 of file gridops.hh.

References eiw, IASN(), RASN(), siw, and width.

TSOpt::GridMaskOp::~GridMaskOp (  ) 

Definition at line 141 of file gridops.hh.


Member Function Documentation

void TSOpt::GridMaskOp::apply ( Vector< float > const &  ,
Vector< float > &   
) const [protected]

void TSOpt::GridMaskOp::applyDeriv ( Vector< float > const &  ,
Vector< float > const &  ,
Vector< float > &   
) const [protected]

void TSOpt::GridMaskOp::applyAdjDeriv ( Vector< float > const &  ,
Vector< float > const &  ,
Vector< float > &   
) const [protected]

void TSOpt::GridMaskOp::applyDeriv2 ( const Vector< float > &  ,
const Vector< float > &  ,
const Vector< float > &  ,
Vector< float > &  dy 
) const [protected]

Definition at line 112 of file gridops.hh.

void TSOpt::GridMaskOp::applyAdjDeriv2 ( const Vector< float > &  ,
const Vector< float > &  ,
const Vector< float > &  ,
Vector< float > &  dx1 
) const [protected]

Definition at line 116 of file gridops.hh.

Operator<float>* TSOpt::GridMaskOp::clone (  )  const [protected]

Definition at line 121 of file gridops.hh.

Space<float> const& TSOpt::GridMaskOp::getDomain (  )  const

Definition at line 143 of file gridops.hh.

Space<float> const& TSOpt::GridMaskOp::getRange (  )  const

Definition at line 144 of file gridops.hh.

ostream& TSOpt::GridMaskOp::write ( ostream &  str  )  const


The documentation for this class was generated from the following file:
Generated on 5 Jan 2017 for IWAVEGRID by  doxygen 1.4.7