FiberVISH 0.2
Fish - The Fiber Bundle API for the Vish Visualization Shell
Classes | Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
Fiber::PointSearch Struct Reference

Point Search Utility functions for finding points in a grid based on provided coordinate information. More...

#include <PointSearch.hpp>

Classes

struct  exception
 
struct  NoVertices
 

Public Member Functions

 PointSearch (Slice &slice, Grid &TheGrid, const string &Gridname)
 

Static Public Member Functions

static string HelperGridname (const string &Gridname)
 The point search stores lookup information in another Grid object on the same slice.
 
static SkeletonID CellID (const Grid &G)
 Return the skeleton ID which is used to cell information.
 
static RefPtr< FieldgetHelperField (const RefPtr< Slice > &slice, const RefPtr< Grid > &TheGrid, const string &Gridname)
 Global high-level functions to inspect whether a certain Grid has a point search helper field.
 
static bool hasLookupFragment (const RefPtr< Field > &HelperFeld, const RefPtr< FragmentID > &f)
 Global function to check if the given HelperField has information stored about the specific fragment ID.
 

Public Attributes

RefPtr< FieldUniMapperField
 
RefPtr< FieldFragmentBoxes
 The cartesian positions of the helper grid, containing the bounding boxes of each fragment in the original grid.
 

Detailed Description

Point Search Utility functions for finding points in a grid based on provided coordinate information.

Constructor & Destructor Documentation

◆ PointSearch()

Fiber::PointSearch::PointSearch ( Slice slice,
Grid TheGrid,
const string &  Gridname 
)
  1. Create a helper Grid object
  2. Modifies the Grid object and creates a relative representation in the cells of the helper Grid.

References CellID(), FragmentBoxes, and HelperGridname().

Member Function Documentation

◆ CellID()

static SkeletonID Fiber::PointSearch::CellID ( const Grid G)
inlinestatic

Return the skeleton ID which is used to cell information.

A cell is an atomic set of vertices (therefore index depth 1) and of the same dimensionality of the vertices.

Referenced by getHelperField(), and PointSearch().

◆ getHelperField()

RefPtr< Field > Fiber::PointSearch::getHelperField ( const RefPtr< Slice > &  slice,
const RefPtr< Grid > &  TheGrid,
const string &  Gridname 
)
static

Global high-level functions to inspect whether a certain Grid has a point search helper field.

Use in combination with hasLookupFragment() to check if there is information about a certain fragment.

References CellID(), std::cout, std::endl(), and HelperGridname().

◆ HelperGridname()

static string Fiber::PointSearch::HelperGridname ( const string &  Gridname)
inlinestatic

The point search stores lookup information in another Grid object on the same slice.

It will be stored under the name as provided by this function.

Referenced by getHelperField(), and PointSearch().