![]()  | 
  
    FlowEngine 8.011
    
   Photogrammetry Software Development Kit 
   | 
 
Namespaces | |
| namespace | Private | 
| using FlowEngine::Color32 = typedef PointColor32 | 
a floating point color with 3 components
| using FlowEngine::ColorComponent = typedef std::uint8_t | 
Color component (8 bits) type.
| using FlowEngine::ColorComponent32 = typedef float | 
Color component (32 bits) type.
| using FlowEngine::ConstStringBuffer = typedef ConstBuffer< char > | 
ConstBuffer of chars to store strings.
| using FlowEngine::Index = typedef std::ptrdiff_t | 
Index type.
| using FlowEngine::PointClassification = typedef int | 
| using FlowEngine::ReconstructionID = typedef unsigned int | 
Unique identification number in a group of cameras.
| using FlowEngine::Size = typedef std::size_t | 
Size type.
| using FlowEngine::StringBuffer = typedef Buffer< char > | 
Buffer of chars to store strings.
| using FlowEngine::UniqueBoundingBoxPtr = typedef Detail::UniquePtr< BoundingBoxInterface > | 
Automatically manages the lifetime of a Bounding box object.
| using FlowEngine::UniqueCameraCalibrationPtr = typedef Detail::UniquePtr< CameraCalibrationInterface > | 
Automatically manages the lifetime of a Camera calibration object.
| using FlowEngine::UniqueCameraConstraintPtr = typedef Detail::UniquePtr< CameraConstraintInterface > | 
Automatically manages the lifetime of a CameraConstraint object.
| using FlowEngine::UniqueCameraGroupManagerPtr = typedef Detail::UniquePtr< CameraGroupManagerInterface > | 
Automatically manages the lifetime of a CameraGroupManager object.
| using FlowEngine::UniqueCameraPtr = typedef Detail::UniquePtr< CameraInterface > | 
Automatically manages the lifetime of a Camera object.
| using FlowEngine::UniqueCamerasLoaderPtr = typedef Detail::UniquePtr< CamerasLoaderInterface > | 
Automatically manages the lifetime of a CamerasLoader object.
| using FlowEngine::UniqueControlPointConstraintPtr = typedef Detail::UniquePtr< ControlPointConstraintInterface > | 
Automatically manages the lifetime of a Control Point Constraint object.
| using FlowEngine::UniqueDistanceConstraintPtr = typedef Detail::UniquePtr< DistanceConstraintInterface > | 
Automatically manages the lifetime of a DistanceConstraint object.
| using FlowEngine::UniqueDynamicBufferPtr = typedef Detail::UniquePtr< DynamicBufferInterface > | 
Automatically manages the lifetime of a DynamicBuffer object.
| using FlowEngine::UniqueFlowEnginePtr = typedef Detail::UniquePtr< FlowEngineInterface > | 
Automatically manages the lifetime of a FlowEngine object.
| using FlowEngine::UniqueLicenseInfoPtr = typedef Detail::UniquePtr< LicenseInfoInterface > | 
Automatically manages the lifetime of a LicenseInfo object.
| using FlowEngine::UniqueOrthophotoPtr = typedef Detail::UniquePtr< OrthophotoInterface > | 
Automatically manages the lifetime of a Orthophoto object.
| using FlowEngine::UniqueProjectedCoordinateSystemPtr = typedef Detail::UniquePtr< ProjectedCoordinateSystemInterface > | 
Automatically manages the lifetime of a ProjectedCoordinateSystem object.
| using FlowEngine::UniqueSettingsPtr = typedef Detail::UniquePtr< SettingsInterface > | 
Automatically manages the lifetime of a Settings object.
| using FlowEngine::UniqueSparsePointCloudPtr = typedef Detail::UniquePtr< SparsePointCloudInterface > | 
Automatically manages the lifetime of a Sparse Point Cloud object.
| using FlowEngine::UniqueStereoMeshPtr = typedef Detail::UniquePtr< StereoMeshInterface > | 
Automatically manages the lifetime of a Stereo mesh object.
| using FlowEngine::UniqueStereoPointCloudPtr = typedef Detail::UniquePtr< StereoPointCloudInterface > | 
Automatically manages the lifetime of a Stereo Point cloud object.
| using FlowEngine::UniqueStereoTexturedMeshPtr = typedef Detail::UniquePtr< StereoTexturedMeshInterface > | 
Automatically manages the lifetime of a Stereo textured mesh object.
| using FlowEngine::UniqueWorkspaceLoaderPtr = typedef Detail::UniquePtr< WorkspaceLoaderInterface > | 
Automatically manages the lifetime of a Workspace Loader object.
| using FlowEngine::UniqueWorkspaceSaverPtr = typedef Detail::UniquePtr< WorkspaceSaverInterface > | 
Automatically manages the lifetime of a Workspace Saver object.
      
  | 
  strong | 
      
  | 
  strong | 
The imaging engine used to read images from mass storage.
| Enumerator | |
|---|---|
| Automatic | Default option, forced on creation of FlowEngine instances. On Windows: Tries the Windows Imaging Component (WIC), fallbacks on ImageMagick on failure. On Linux: Defaults to ImageMagick  | 
| ImageMagick | Image Magick Powerful library that handles most of the image formats in existance.  | 
      
  | 
  strong | 
      
  | 
  strong | 
      
  | 
  strong | 
Enumerates possible results generated by FlowEngine.
| Enumerator | |
|---|---|
| Success | Everything went ok.  | 
| FeatureNotAvailable | This feature is not available in this version of FlowEngine.  | 
| GenericError | Something went wrong. Usually the log contains more detailed information.  | 
| InvalidArgument | One or more supplied arguments are invalid.  | 
| FileNotFound | File not found.  | 
| BufferTooSmall | The provided buffer is too small to complete the operation.  | 
| GenericIOError | Something went wrong while reading or writing a file. During a read, it may indicate a parsing error or a file corruption.  | 
| ProcessNotRunning | An abort or pause signal has been emitted, but no process is running.  | 
| NewVersionAvailable | A New SDK version is available to download.  | 
| OutOfMemoryError | An out of RAM memory error has been received.  | 
| DiskWriteError | An error has occurred on disk write. Common situations include: 
  | 
| PreconditionNotMet | One or more preconditions were not met.  | 
| UnsupportedVersion | The version of the loading 3DK is not supported or did not match the minimum requirements.  | 
| LicenseCheckFailed | The license check failed. Possible reasons include: 
  | 
      
  | 
  strong | 
| FLE_DLL Result FlowEngine::ComputeCamerasRating | ( | Buffer< CameraInterface * > | cameras, | 
| Buffer< Pair< CameraInterface *, Point2 > > | selectedPoints, | ||
| Buffer< int > | inOutRatings | ||
| ) | 
Compute camera ratings based on point visibility.
| FLE_DLL BoundingBoxInterface * FlowEngine::CreateBoundingBox | ( | ) | 
Creates a BoundingBox object
| FLE_DLL CameraInterface * FlowEngine::CreateCamera | ( | ) | 
Creates a Camera object
| FLE_DLL CameraCalibrationInterface * FlowEngine::CreateCameraCalibration | ( | ) | 
Creates a CameraCalibration object
| FLE_DLL CameraConstraintInterface * FlowEngine::CreateCameraConstraint | ( | ) | 
Creates a Camera Constraint object
| FLE_DLL CameraGroupManagerInterface * FlowEngine::CreateCameraGroupManager | ( | ) | 
Creates a CameraGroupManagerInterface object
| FLE_DLL CamerasLoaderInterface * FlowEngine::CreateCamerasLoader | ( | ) | 
Creates a CamerasLoader object
| FLE_DLL ControlPointConstraintInterface * FlowEngine::CreateControlPointConstraint | ( | ) | 
Creates a Control Point Constraint object
| FLE_DLL DistanceConstraintInterface * FlowEngine::CreateDistanceConstraint | ( | ) | 
Creates a Distance Constraint object
| FLE_DLL DynamicBufferInterface * FlowEngine::CreateDynamicBuffer | ( | ) | 
Creates a DynamicBuffer object
| FlowEngine::FlowEngineInterface * FlowEngine::CreateFlowEngine | ( | ) | 
Creates a FlowEngineInterface object.
| FLE_DLL LicenseInfoInterface * FlowEngine::CreateLicenseInfo | ( | ) | 
Creates a LicenseInfo object
| FLE_DLL OrthophotoInterface * FlowEngine::CreateOrthophoto | ( | ) | 
Creates an Orthophoto object
| FLE_DLL ProjectedCoordinateSystemInterface * FlowEngine::CreateProjectedCoordinateSystem | ( | ) | 
Creates a ProjectedCoordinateSystem object
| FLE_DLL SettingsInterface * FlowEngine::CreateSettings | ( | ) | 
Creates a Settings object
| FLE_DLL SparsePointCloudInterface * FlowEngine::CreateSparsePointCloud | ( | ) | 
Creates a SparsePointCloud object
| FLE_DLL StereoMeshInterface * FlowEngine::CreateStereoMesh | ( | ) | 
Creates a StereoMesh object
| FLE_DLL StereoPointCloudInterface * FlowEngine::CreateStereoPointCloud | ( | ) | 
Creates a StereoPointCloud object
| FLE_DLL StereoTexturedMeshInterface * FlowEngine::CreateStereoTexturedMesh | ( | ) | 
Creates a StereoTexturedMesh object
| FLE_DLL WorkspaceLoaderInterface * FlowEngine::CreateWorkspaceLoader | ( | ) | 
Creates a WorkspaceLoader object
| FLE_DLL WorkspaceSaverInterface * FlowEngine::CreateWorkspaceSaver | ( | ) | 
Creates a WorkspaceSaver object
| FLE_DLL void FlowEngine::DestroyBoundingBox | ( | BoundingBoxInterface * | boundingBox | ) | 
Destroys a BoundingBox object
| [in,out] | boundingBox | pointer to a BoundingBox created with CreateBoundingBox() | 
| FLE_DLL void FlowEngine::DestroyCamera | ( | CameraInterface * | camera | ) | 
Destroys a Camera object
| [in] | camera | pointer to a Camera created with CreateCamera() | 
| FLE_DLL void FlowEngine::DestroyCameraCalibration | ( | CameraCalibrationInterface * | cameraCalibration | ) | 
Destroys a CameraCalibration object
| [in,out] | cameraCalibration | pointer to a CameraCalibration created with CreateCameraCalibration() | 
| FLE_DLL void FlowEngine::DestroyCameraConstraint | ( | CameraConstraintInterface * | cameraConstraint | ) | 
Destroys a Cameera Constraint object
| [in] | cameraConstraint | pointer to a Camera Constraint created with CreateCameraConstraint() | 
| FLE_DLL void FlowEngine::DestroyCameraGroupManager | ( | CameraGroupManagerInterface * | cameraGroupManager | ) | 
Destroys a CameraGroupManagerInterface object
| [in] | cameraGroupManager | pointer to a CameraGroupManagerInterface created with CreateCameraGroupManager() | 
| FLE_DLL void FlowEngine::DestroyCamerasLoader | ( | CamerasLoaderInterface * | camerasLoader | ) | 
Destroys a CamerasLoader object
| [in] | camerasLoader | pointer to a CamerasLoader created with CreateCamerasLoader() | 
| FLE_DLL void FlowEngine::DestroyControlPointConstraint | ( | ControlPointConstraintInterface * | controlPoint | ) | 
Destroys a Control Point Constraint object
| [in] | controlPoint | pointer to a Control Point Constraint created with CreateControlPointConstraint() | 
| FLE_DLL void FlowEngine::DestroyDistanceConstraint | ( | DistanceConstraintInterface * | distance | ) | 
Destroys a Distance Constraint object
| [in] | distance | pointer to a Distance Constraint created with CreateDistanceConstraint() | 
| FLE_DLL void FlowEngine::DestroyDynamicBuffer | ( | DynamicBufferInterface * | buf | ) | 
Destroys a DynamicBuffer object
| [in] | buf | pointer to a DynamicBuffer created with CreateDynamicBuffer() | 
| void FlowEngine::DestroyFlowEngine | ( | FlowEngine::FlowEngineInterface * | flowEngine | ) | 
Destroys a FlowEngineInterface object.
| [in] | flowEngine | pointer to a FlowEngineInterface object created with CreateFlowEngineObject(). | 
| void FlowEngine::DestroyFlowEngineObject | ( | FlowEngine::FlowEngineInterface * | flowEngine | ) | 
Destroys a FlowEngineInterface object.
| [in] | flowEngine | pointer to a FlowEngineInterface object created with CreateFlowEngineObject(). | 
| FLE_DLL void FlowEngine::DestroyLicenseInfo | ( | LicenseInfoInterface * | info | ) | 
Destroys a LicenseInfo object
| [in] | info | pointer to a LicenseInfo created with CreateLicenseInfo() | 
| FLE_DLL void FlowEngine::DestroyOrthophoto | ( | OrthophotoInterface * | orthophoto | ) | 
Destroys an Orthophoto object
| [in,out] | orthophoto | pointer to an Orthophoto created with CreateOrthophoto() | 
| FLE_DLL void FlowEngine::DestroyProjectedCoordinateSystem | ( | ProjectedCoordinateSystemInterface * | pcs | ) | 
Destroys a ProjectedCoordinateSystem object
| [in] | pcs | pointer to a ProjectedCoordinateSystem created with CreateProjectedCoordinateSystem() | 
| FLE_DLL void FlowEngine::DestroySettings | ( | SettingsInterface * | settings | ) | 
Destroyes a Settings object
| [in] | settings | a pointer to a Settings created with CreateSettings() | 
| FLE_DLL void FlowEngine::DestroySparsePointCloud | ( | SparsePointCloudInterface * | pointCloud | ) | 
Destroys a SparsePointCloud object
| [in,out] | pointCloud | pointer to a BoundingBox created with CreateBoundingBox() | 
| FLE_DLL void FlowEngine::DestroyStereoMesh | ( | StereoMeshInterface * | stereoMesh | ) | 
Destroys a StereoMesh object
| [in] | stereoMesh | pointer to a StereoMesh created with CreateStereoMesh() | 
| FLE_DLL void FlowEngine::DestroyStereoPointCloud | ( | StereoPointCloudInterface * | stereoPointCloud | ) | 
Destroys a StereoPointCloud object
| [in] | stereoPointCloud | pointer to a StereoPointCloud created with CreateStereoPointCloud() | 
| FLE_DLL void FlowEngine::DestroyStereoTexturedMesh | ( | StereoTexturedMeshInterface * | stereoTexturedMesh | ) | 
Destroys a StereoMesh object
| [in] | stereoTexturedMesh | pointer to a StereoTexturedMesh created with CreateStereoTexturedMesh() | 
| FLE_DLL void FlowEngine::DestroyWorkspaceLoader | ( | WorkspaceLoaderInterface * | workspaceLoader | ) | 
Destroys a WorkspaceLoader object
| [in] | workspaceLoader | pointer to a WorkspaceLoader object created with CreateWorkspaceLoader() | 
| FLE_DLL void FlowEngine::DestroyWorkspaceSaver | ( | WorkspaceSaverInterface * | workspaceSaver | ) | 
Destroys a WorkspaceSaver object
| [in] | workspaceSaver | pointer to a WorkspaceSaver created with CreateWorkspaceSaver() | 
| FLE_DLL const char * FlowEngine::GetResultMessage | ( | Result | inResult | ) | 
| [in] | inResult | the result code | 
| FLE_DLL Result FlowEngine::SampleEpipolarLine | ( | const CameraInterface & | referenceCamera, | 
| const Point2 & | referencePoint, | ||
| const CameraInterface & | targetCamera, | ||
| int | sampleCount, | ||
| Buffer< Point2 > | inOutPoints | ||
| ) | 
Samples the epipolar line for a point chosen on a reference camera w.r.t. another camera. The line (note that it may be distorted due tue radial distortion) will be sampled inOutPoints.count times. 
| [in] | referenceCamera | the camera whose epipolar line to be projected | 
| [in] | referencePoint | the coordinates of the point in the referenceCamera | 
| [in] | sampleCount | the number of samples to take. Must be greater-equal than 2. | 
| [in,out] | inOutPoints | an array of Points2 that will be filled with samples of the epipolar line. Must be at least sampleCount long  | 
inOutPoints has been filled with the epipolar line samples.targetCamera is the same as referenceCamera.inOutPoints is not a valid buffer.inOutPoints is not at least sampleCount elements long.