Examples/SpatialObjects/EllipseSpatialObject.cxx

/*=========================================================================
 *
 *  Copyright NumFOCUS
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *         https://www.apache.org/licenses/LICENSE-2.0.txt
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 *=========================================================================*/
 
// Software Guide : BeginLatex
//
// \index{itk::EllipseSpatialObject}
//
// \doxygen{EllipseSpatialObject} defines an n-dimensional ellipse. Like
// other spatial objects this class derives from
// \doxygen{SpatialObject}. Let's start by including the appropriate header
// file.
//
// Software Guide : EndLatex
 
// Software Guide : BeginCodeSnippet
#include "itkEllipseSpatialObject.h"
// Software Guide : EndCodeSnippet
 
int
main(int, char *[])
{
  // Software Guide : BeginLatex
  //
  // Like most of the SpatialObjects, the \doxygen{EllipseSpatialObject} is
  // templated over the dimension of the space. In this example we create a
  // 3-dimensional ellipse.
  //
  // Software Guide : EndLatex
 
  // Software Guide : BeginCodeSnippet
  using EllipseType = itk::EllipseSpatialObject<3>;
  auto myEllipse = EllipseType::New();
  // Software Guide : EndCodeSnippet
 
  // Software Guide : BeginLatex
  //
  // Then we set a radius for each dimension. By default the radius is set
  // to 1. Additionally, after setting the SpatialObject's radius, we call
  // \code{Update()} to update all transforms, bounding box, and other
  // convenience variables within the class that its other member functions
  // (e.g., \code{IsInsideInWorldSpace()}) depend upon.
  //
  // Software Guide : EndLatex
  // Software Guide : BeginCodeSnippet
  EllipseType::ArrayType radius;
  for (unsigned int i = 0; i < 3; ++i)
  {
    radius[i] = i;
  }
 
  myEllipse->SetRadiusInObjectSpace(radius);
  myEllipse->Update();
  // Software Guide : EndCodeSnippet
  // Software Guide : BeginLatex
  //
  // Or if we have the same radius in each dimension we can do
  //
  // Software Guide : EndLatex
  // Software Guide : BeginCodeSnippet
  myEllipse->SetRadiusInObjectSpace(2.0);
  myEllipse->Update();
  // Software Guide : EndCodeSnippet
 
  // Software Guide : BeginLatex
  //
  // We can then display the current radius by using the
  // \code{GetRadiusInObjectSpace()} function:
  //
  // Software Guide : EndLatex
  // Software Guide : BeginCodeSnippet
  const EllipseType::ArrayType myCurrentRadius =
    myEllipse->GetRadiusInObjectSpace();
  std::cout << "Current radius is " << myCurrentRadius << std::endl;
  // Software Guide : EndCodeSnippet
 
  // Software Guide : BeginLatex
  //
  // Like other SpatialObjects, we can query the object if a point is inside
  // the object by using the \code{IsInsideInWorldSpace(itk::Point)} function.
  // This function expects the point to be in world coordinates.
  //
  // Software Guide : EndLatex
 
  // Software Guide : BeginCodeSnippet
  auto insidePoint = itk::MakeFilled<itk::Point<double, 3>>(1.0);
  if (myEllipse->IsInsideInWorldSpace(insidePoint))
  {
    std::cout << "The point " << insidePoint;
    std::cout << " is really inside the ellipse" << std::endl;
  }
 
  auto outsidePoint = itk::MakeFilled<itk::Point<double, 3>>(3.0);
  if (!myEllipse->IsInsideInWorldSpace(outsidePoint))
  {
    std::cout << "The point " << outsidePoint;
    std::cout << " is really outside the ellipse" << std::endl;
  }
  // Software Guide : EndCodeSnippet
 
  // Software Guide : BeginLatex
  //
  // All spatial objects can be queried for a value at a point.  The
  // \code{IsEvaluableAtInWorldSpace()} function returns a boolean to know
  // if the object is evaluable at a particular point.
  //
  // Software Guide : EndLatex
 
  // Software Guide : BeginCodeSnippet
  if (myEllipse->IsEvaluableAtInWorldSpace(insidePoint))
  {
    std::cout << "The point " << insidePoint;
    std::cout << " is evaluable at the point " << insidePoint << std::endl;
  }
  // Software Guide : EndCodeSnippet
 
  // Software Guide : BeginLatex
  //
  //  If the object is evaluable at that point, the
  //  \code{ValueAtInWorldSpace()} function returns the current value at that
  //  position.  Most of the objects returns a boolean value which is set to
  //  true when the point is inside the object and false when it is outside.
  //  However, for some objects, it is more interesting to return a value
  //  representing, for instance, the distance from the center of the object
  //  or the distance from the boundary.
  //
  // Software Guide : EndLatex
 
  // Software Guide : BeginCodeSnippet
  double value;
  myEllipse->ValueAtInWorldSpace(insidePoint, value);
  std::cout << "The value inside the ellipse is: " << value << std::endl;
  // Software Guide : EndCodeSnippet
 
  // Software Guide : BeginLatex
  //
  // Like other spatial objects, we can also query the bounding box of the
  // object by using \code{GetMyBoundingBoxInWorldSpace()}. The resulting
  // bounding box is the world space.
  //
  // Software Guide : EndLatex
 
  // Software Guide : BeginCodeSnippet
  const EllipseType::BoundingBoxType * boundingBox =
    myEllipse->GetMyBoundingBoxInWorldSpace();
  std::cout << "Bounding Box: " << boundingBox->GetBounds() << std::endl;
  // Software Guide : EndCodeSnippet
 
  return EXIT_SUCCESS;
}