PixInsight

https://pixinsight.com
Admin
PixInsight is an advanced image processing platform specialized in astrophotography, available for...
Tokens:4,239,643
Snippets:24,495
Trust Score:9.4
Update:6 months ago
Show doc for...
Tokens:
Raw
### GET /process/all

Source: https://pixinsight.com/developer/pcl/doc/html/classpcl_1_1Process.html

Retrieves a list of all currently installed processes.

```APIDOC
## GET /process/all

### Description
Returns a list of all currently installed processes on the PixInsight core application.

### Method
GET

### Response
#### Success Response (200)
- **processes** (Array<Process>) - A list of all installed process objects.
```

--------------------------------

### Get All Installed File Formats

Source: https://pixinsight.com/developer/pcl/doc/html/classpcl_1_1FileFormat.html

Returns a list containing all file formats currently installed in the PixInsight core application.

```cpp
static Array<FileFormat> pcl::FileFormat::AllFormats()
```

--------------------------------

### File List Example

Source: https://pixinsight.com/developer/pcl/doc/html/XML_8h_source.html

An example of the file list provided in the PixInsight Core Library documentation.

```APIDOC
## File List

### Description
Lists individual header files within the PixInsight Core Library.

### Files
- AbstractImage.h
- Action.h
- AdaptiveLocalFilter.h
- AkimaInterpolation.h
- Algebra.h
- AlignedAllocator.h
- Allocator.h
- APASSDatabaseFile.h
- Arguments.h
- Array.h
- Association.h
- AstrometricMetadata.h
- AstrometricReprojection.h
- Atomic.h
- ATrousWaveletTransform.h
- AutoLock.h
- AutoPointer.h
- AutoStatusCallbackRestorer.h
- AutoViewLock.h
- BicubicFilterInterpolation.h
- BicubicInterpolation.h
- BidimensionalInterpolation.h
- BilinearInterpolation.h
- Bitmap.h
- BitmapBox.h
- Brush.h
- Button.h
- ButtonCodes.h
- ByteArray.h
- CanvasColor.h
- CharTraits.h
- ChebyshevFit.h
- CheckBox.h
- Checksum.h
- CodeEditor.h
- Color.h
- ColorComboBox.h
- ColorDialog.h
- ColorFilterArray.h
- ColorSpace.h
- ComboBox.h
- Complex.h
- Compression.h
- Console.h
- Constants.h
- Container.h
- Control.h
- Convolution.h
- Crop.h
- Cryptography.h
- CubicSplineInterpolation.h
- CUDADevice.h
- Cursor.h
- Defs.h
- Diagnostics.h
- Dialog.h
- DisplayFunction.h
- DrizzleData.h
- Edit.h
- ElapsedTime.h
- EndianConversions.h
- EphemerisFile.h
- ErrorHandler.h
- Exception.h
- ExternalProcess.h
- FastRotation.h
- FFT1D.h
- FFT2D.h
- FFTConvolution.h
- FFTRegistration.h
- File.h
- FileDataCache.h
- FileDataCachePreferencesDialog.h
- FileDialog.h
- FileFormat.h
- FileFormatBase.h
- FileFormatImplementation.h
- FileFormatInstance.h
- FileInfo.h
- FilterManager.h
- FITSHeaderKeyword.h
- Flags.h
- FluxCalibrationData.h
- Font.h
- FontComboBox.h
- FourierTransform.h
- Frame.h
- GaiaDatabaseFile.h
- GaussianFilter.h
- GeometricTransformation.h
- GlobalSettings.h
- GnomonicProjection.h
- Graphics.h
- GridInterpolation.h
- GroupBox.h
```

--------------------------------

### Start

Source: https://pixinsight.com/developer/pcl/doc/html/classpcl_1_1ExternalProcess-members.html

Starts an external process asynchronously.

```APIDOC
## Start(const String &program, const StringList &arguments)

### Description
Starts the specified program as an external process.

### Method
Instance Method

### Parameters
#### Request Body
- **program** (String) - Required - The path to the executable.
- **arguments** (StringList) - Optional - A list of arguments to pass to the program.
```

--------------------------------

### PCL File List Example

Source: https://pixinsight.com/developer/pcl/doc/html/GaiaDatabaseFile_8h_source.html

An example snippet showing a portion of the file list within the PixInsight Core Library.

```APIDOC
## PCL File List

### Description
This section lists the header files included in the PixInsight Core Library.

### Files
- AbstractImage.h
- Action.h
- AdaptiveLocalFilter.h
- AkimaInterpolation.h
- Algebra.h
- AlignedAllocator.h
- Allocator.h
- APASSDatabaseFile.h
- Arguments.h
- Array.h
- Association.h
- AstrometricMetadata.h
- AstrometricReprojection.h
- Atomic.h
- ATrousWaveletTransform.h
- AutoLock.h
- AutoPointer.h
- AutoStatusCallbackRestorer.h
- AutoViewLock.h
- BicubicFilterInterpolation.h
- BicubicInterpolation.h
- BidimensionalInterpolation.h
- BilinearInterpolation.h
- Bitmap.h
- BitmapBox.h
- Brush.h
- Button.h
- ButtonCodes.h
- ByteArray.h
- CanvasColor.h
- CharTraits.h
- ChebyshevFit.h
- CheckBox.h
- Checksum.h
- CodeEditor.h
- Color.h
- ColorComboBox.h
- ColorDialog.h
- ColorFilterArray.h
- ColorSpace.h
- ComboBox.h
- Complex.h
- Compression.h
- Console.h
- Constants.h
- Container.h
- Control.h
- Convolution.h
- Crop.h
- Cryptography.h
- CubicSplineInterpolation.h
- CUDADevice.h
- Cursor.h
- Defs.h
- Diagnostics.h
- Dialog.h
- DisplayFunction.h
- DrizzleData.h
- Edit.h
- ElapsedTime.h
- EndianConversions.h
- EphemerisFile.h
- ErrorHandler.h
- Exception.h
- ExternalProcess.h
- FastRotation.h
- FFT1D.h
- FFT2D.h
- FFTConvolution.h
- FFTRegistration.h
- File.h
- FileDataCache.h
- FileDataCachePreferencesDialog.h
- FileDialog.h
- FileFormat.h
- FileFormatBase.h
- FileFormatImplementation.h
- FileFormatInstance.h
- FileInfo.h
- FilterManager.h
- FITSHeaderKeyword.h
- Flags.h
- FluxCalibrationData.h
- Font.h
- FontComboBox.h
- FourierTransform.h
- Frame.h
- GaiaDatabaseFile.h
- GaussianFilter.h
- GeometricTransformation.h
- GlobalSettings.h
- GnomonicProjection.h
- Graphics.h
- GridInterpolation.h
- GroupBox.h
```

--------------------------------

### File List Example

Source: https://pixinsight.com/developer/pcl/doc/html/ImageColor_8h_source.html

An example of the file list provided within the PCL documentation.

```APIDOC
## File List

### Description
Provides a comprehensive list of header files within the PCL.

### Example Files
- AbstractImage.h
- Action.h
- AdaptiveLocalFilter.h
- APASSDatabaseFile.h
- Arguments.h
- ByteArray.h
- CharTraits.h
- ColorFilterArray.h
- Cryptography.h
- Diagnostics.h
- File.h
- FileInfo.h
- FilterManager.h
- FITSHeaderKeyword.h
- GnomonicProjection.h
```

--------------------------------

### Get All Processes (C++)

Source: https://pixinsight.com/developer/pcl/doc/html/Process_8h_source.html

Retrieves an array of all installed processes in the PixInsight environment. This is a static method of the Process class.

```cpp
static Array< Process > AllProcesses()
```

--------------------------------

### Create and Start MaxPosThread Instances

Source: https://pixinsight.com/developer/pcl/doc/html/Image_8h_source.html

Initializes and starts multiple MaxPosThread instances for parallel processing. Thread affinity is applied if 'useAffinity' is true.

```cpp
ReferenceArray<MaxPosThread> threads;
for ( int i = 0, n = 0; i < int( L.Length() ); n += int( L[i++] ) )
threads.Add( new MaxPosThread( *this, r, firstChannel, lastChannel, n, n + int( L[i] ) ) );
if ( threads.Length() > 1 )
{
int n = 0;
for ( MaxPosThread& thread : threads )
thread.Start( ThreadPriority::DefaultMax, useAffinity ? n++ : -1 );
for ( MaxPosThread& thread : threads )
thread.Wait();
}
else
threads[0].Run();
```

--------------------------------

### begin() - STL-compatible

Source: https://pixinsight.com/developer/pcl/doc/html/classpcl_1_1ReferenceArray.html

Provides STL-compatible iteration, equivalent to Begin().

```APIDOC
## begin() [1/2]

### Description
STL-compatible iteration. Equivalent to Begin().

### Method
`iterator begin()

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
None

#### Response Example
None
```

--------------------------------

### Get Observation Start Time

Source: https://pixinsight.com/developer/pcl/doc/html/AstrometricMetadata_8h_source.html

Returns the observation start time if defined. Otherwise, returns an undefined Optional<TimePoint>.

```cpp
Optional<TimePoint> ObservationStartTime() const
{
    return m_obsStartTime;
}
```

--------------------------------

### Start()

Source: https://pixinsight.com/developer/pcl/doc/html/classpcl_1_1ExternalProcess.html

Attempts to execute an external process and opens its standard I/O streams.

```APIDOC
## Start()

### Description
Attempts to execute an external process. This function implicitly opens the standard input, output, and error I/O streams of the running process.

### Parameters
- **program** (String) - Required - Path to the executable file.
- **arguments** (StringList) - Optional - List of command-line arguments. Defaults to an empty list.

### Error Handling
Throws an Error exception if the program cannot be executed (e.g., file does not exist or insufficient privileges).
```

--------------------------------

### Example Observation Start Time Property

Source: https://pixinsight.com/doc/docs/XISF-1.0-spec/XISF-1.0-spec.html

This XML snippet illustrates the format for specifying the start time of an observation in UTC.

```xml
<Property id="Observation:Time:Start" type="TimePoint" value="2015-01-23T19:52:31.46Z" />
```

--------------------------------

### PCL Class List Example

Source: https://pixinsight.com/developer/pcl/doc/html/classpcl_1_1MetaInteger-members.html

An example snippet showing a portion of the PCL class list, starting with 'AbstractFFT' and ending with 'Daubechies10Filter'.

```APIDOC
## PCL Class List Example

### Description
This section provides a partial list of classes available in the PCL.

### Classes
- AbstractFFT
- AbstractFFT2D
- AbstractImage
- Action
- ActionInfo
- AdaptiveLocalFilter
- AES256
- AkimaInterpolation
- AlignedAllocator
- Allocator
- AlphaTrimmedMeanFilter
- AngleConversionOptions
- APASSDatabaseFile
- APASSStarData
- Argument
- Array
- Association
- AstrometricMetadata
- AstrometricReprojection
- AtomicInt
- ATrousWaveletTransform
- AutoLock
- AutoLockCounter
- AutoPointer
- AutoPointerCloner
- AutoReentrancyGuard
- AutoStatusCallbackRestorer
- AutoViewLock
- AutoViewWriteLock
- BayerFilterBGGR
- BayerFilterGBRG
- BayerFilterGRBG
- BayerFilterRGGB
- BicubicBSplineInterpolation
- BicubicBSplinePixelInterpolation
- BicubicFilterInterpolation
- BicubicFilterPixelInterpolation
- BicubicInterpolation
- BicubicInterpolationBase
- BicubicPixelInterpolation
- BicubicSplineInterpolation
- BicubicSplinePixelInterpolation
- BidimensionalInterpolation
- BidirectionalImageTransformation
- BidirectionalIterator
- BilinearInterpolation
- BilinearPixelInterpolation
- Bitmap
- BitmapBox
- BitmapStructure
- BoxStructure
- Brush
- Button
- CanvasColor
- CatmullRomSplineFilter
- CaughtException
- CharTraits
- CheckBox
- Cipher
- CircularStructure
- CodeEditor
- ColorComboBox
- ColorFilterArray
- ComboBox
- Complex
- ComplexPixelTraits
- Compression
- ConicalGradientBrush
- ConsistentlyDefined
- Console
- Const
- Container
- Control
- Convolution
- Crop
- CryptographicHash
- CryptographicHashFactory
- CubicBSplineFilter
- CubicFilter
- CubicSplineInterpolation
- CUDADevice
- Cursor
- Daubechies10Filter
- Daubechies12Filter
```

--------------------------------

### begin()

Source: https://pixinsight.com/developer/pcl/doc/html/classpcl_1_1GenericMatrix.html

Provides an STL-compatible iterator for the matrix.

```APIDOC
## begin()

### Description
Returns an STL-compatible iterator for the matrix. This is equivalent to the Begin() const method.

### Method
const_block_iterator

### Parameters
None
```

--------------------------------

### Begin() and begin()

Source: https://pixinsight.com/developer/pcl/doc/html/classpcl_1_1KernelFilter.html

Provides access to the beginning of the internal filter coefficients.

```APIDOC
## Begin()

### Description
Returns a pointer to the beginning of the internal matrix of (immutable) filter coefficients. Coefficients are stored in row order.

### Method
`const coefficient* pcl::KernelFilter::Begin() const`

### Endpoint
N/A

### Parameters
None

### Request Example
```json
{
  "example": "const coefficient* coeffs = kernelFilter.Begin();"
}
```

### Response
#### Success Response (N/A)
- **coefficient*** - A pointer to the first filter coefficient.

#### Response Example
```json
{
  "example": "// Pointer to the start of the coefficient data"
}
```

## begin()

### Description
STL-compatible iteration. Equivalent to `Begin() const`.

### Method
`const coefficient* pcl::KernelFilter::begin() const`

### Endpoint
N/A

### Parameters
None

### Request Example
```json
{
  "example": "auto it = kernelFilter.begin();"
}
```

### Response
#### Success Response (N/A)
- **coefficient*** - A pointer to the first filter coefficient.

#### Response Example
```json
{
  "example": "// STL-compatible iterator to the start of the coefficient data"
}
```
```

--------------------------------

### PCL Class List Example

Source: https://pixinsight.com/developer/pcl/doc/html/classpcl_1_1Rotation-members.html

An example snippet showing a portion of the class list within the PCL library, focusing on classes starting with 'A' and 'B'.

```APIDOC
## PCL Class List Example

### Description
Illustrates a segment of the class listing for the PCL library.

### Classes
- ►AbstractFFT
- ►AbstractFFT2D
- ►AbstractImage
- ►Action
- ►ActionInfo
- ►AdaptiveLocalFilter
- ►AES256
- ►AkimaInterpolation
- ►AlignedAllocator
- ►Allocator
- ►AlphaTrimmedMeanFilter
- ►AngleConversionOptions
- ►APASSDatabaseFile
- ►APASSStarData
- ►Argument
- ►Array
- ►Association
- ►AstrometricMetadata
- ►AstrometricReprojection
- ►AtomicInt
- ►ATrousWaveletTransform
- ►AutoLock
- ►AutoLockCounter
- ►AutoPointer
- ►AutoPointerCloner
- ►AutoReentrancyGuard
- ►AutoStatusCallbackRestorer
- ►AutoViewLock
- ►AutoViewWriteLock
- BayerFilterBGGR
- BayerFilterGBRG
- BayerFilterGRBG
- BayerFilterRGGB
- ►BicubicBSplineInterpolation
- ►BicubicBSplinePixelInterpolation
- ►BicubicFilterInterpolation
- ►BicubicFilterPixelInterpolation
- ►BicubicInterpolation
- ►BicubicInterpolationBase
- ►BicubicPixelInterpolation
- ►BicubicSplineInterpolation
- ►BicubicSplinePixelInterpolation
- ►BidimensionalInterpolation
- ►BidirectionalImageTransformation
- BidirectionalIterator
- ►BilinearInterpolation
- ►BilinearPixelInterpolation
- ►Bitmap
- ►BitmapBox
- ►BitmapStructure
- ►BoxStructure
- ►Brush
- ►Button
- ►CanvasColor
- ►CatmullRomSplineFilter
- ►CaughtException
- ►CharTraits
- ►CheckBox
- ►Cipher
- ►CircularStructure
- ►CodeEditor
- ►ColorComboBox
- ►ColorFilterArray
- ►ComboBox
- ►Complex
- ►ComplexPixelTraits
- ►Compression
- ►ConicalGradientBrush
- ►ConsistentlyDefined
- ►Console
- Const
- Container
- ►Control
- ►Convolution
- ►Crop
- ►CryptographicHash
- ►CryptographicHashFactory
- ►CubicBSplineFilter
- ►CubicFilter
- ►CubicSplineInterpolation
- ►CUDADevice
- ►Cursor
- ►Daubechies10Filter
- ►Daubechies12Filter
```

--------------------------------

### GET /ProcessInstance/CanLaunchInterface

Source: https://pixinsight.com/developer/pcl/doc/html/classpcl_1_1ProcessInstance.html

Checks if the process instance is capable of opening and activating a user interface.

```APIDOC
## GET /ProcessInstance/CanLaunchInterface

### Description
Returns true if this process instance is able to open and activate a process interface.

### Method
GET

### Response
#### Success Response (200)
- **result** (bool) - True if the interface can be launched, false otherwise.
```

--------------------------------

### Get Location

Source: https://pixinsight.com/developer/pcl/doc/html/DrizzleData_8h_source.html

Retrieves the location vector. No specific setup is required.

```cpp
const DVector& Location() const
{
  return m_location;
}
```

--------------------------------

### Module Utility Methods

Source: https://pixinsight.com/developer/pcl/doc/html/MetaModule_8h_source.html

Methods for checking installation status, processing events, and managing resources.

```cpp
523 bool IsInstalled() const;
```

```cpp
559 void ProcessEvents( bool excludeUserInputEvents = false );
```

```cpp
631 void LoadResource( const String& filePath, const String& rootPath = String() );
```

```cpp
652 void UnloadResource( const String& filePath, const String& rootPath = String() );
```

```cpp
690 Variant EvaluateScript( const String& sourceCode, const IsoString& language = IsoString() );
```

```cpp
711 bool HasEntitlement( const IsoString& entitlement );
```

--------------------------------

### Get Metadata

Source: https://pixinsight.com/developer/pcl/doc/html/DrizzleData_8h_source.html

Retrieves the metadata string. No specific setup is required.

```cpp
const String& Metadata() const
{
  return m_metadata;
}
```

--------------------------------

### Get Reference Location

Source: https://pixinsight.com/developer/pcl/doc/html/DrizzleData_8h_source.html

Retrieves the reference location vector. No specific setup is required.

```cpp
const DVector& ReferenceLocation() const
{
  return m_referenceLocation;
}
```

--------------------------------

### Get Reference Height

Source: https://pixinsight.com/developer/pcl/doc/html/DrizzleData_8h_source.html

Retrieves the reference height of the image or process. No specific setup is required.

```cpp
int ReferenceHeight() const
{
  return m_referenceHeight;
}
```

--------------------------------

### Initialize

Source: https://pixinsight.com/developer/pcl/doc/html/classpcl_1_1FFTRegistrationEngine.html

Initializes the registration engine for a specified reference image.

```APIDOC
## Initialize

### Description
Initializes this registration engine for the specified reference image. Subsequent calls to Evaluate() will compute registration parameters for target images referred to the same reference image.

### Parameters
#### Path Parameters
- **_image_** (const pcl::GenericImage<P> &) - Required - The reference image to initialize the engine with.
```

--------------------------------

### Get Reference Width

Source: https://pixinsight.com/developer/pcl/doc/html/DrizzleData_8h_source.html

Retrieves the reference width of the image or process. No specific setup is required.

```cpp
int ReferenceWidth() const
{
  return m_referenceWidth;
}
```

--------------------------------

### PCL Class Member Details (Example: 'a')

Source: https://pixinsight.com/developer/pcl/doc/html/functions_type.html

Specific details for members starting with 'a' within PCL classes.

```APIDOC
## PCL Class Member Details ('a')

### Description
Lists members (variables, functions, typedefs, etc.) within PCL classes whose names start with the letter 'a'.

### Members starting with 'a'
- **abs_resize_mode** (pcl::Resample)
- **algorithm_implementation** (pcl::FGaussJordan, pcl::FInPlaceSVD, pcl::FSVD, pcl::GaussJordan, pcl::GenericSVD< T >, pcl::InPlaceSVD, pcl::SVD)
- **allocator** (pcl::Array< T, A >, pcl::GenericString< T, R, A >, pcl::IndirectArray< T, A >, pcl::IndirectSortedArray< T, A >, pcl::IsoString, pcl::ReferenceArray< T, A >, pcl::ReferenceSortedArray< T, A >, pcl::SortedArray< T, A >, pcl::String)
- **array_implementation** (pcl::IndirectArray< T, A >, pcl::IndirectSortedArray< T, A >, pcl::ReferenceArray< T, A >, pcl::ReferenceSortedArray< T, A >, pcl::SortedArray< T, A >)
- **array_iterator** (pcl::IndirectArray< T, A >)
```

--------------------------------

### Launch()

Source: https://pixinsight.com/developer/pcl/doc/html/classpcl_1_1ProcessImplementation.html

Launches the process instance, determining the execution context based on interface availability and metaprocess preferences.

```APIDOC
## Launch()

### Description
Launches this process instance. The execution path depends on interface selection, metaprocess preferences, and the availability of a current view.

### Method
void

### Endpoint
pcl::ProcessImplementation::Launch

### Response
#### Success Response (200)
This method does not return a value, but initiates process execution.

### Behavior
1. Calls `SelectInterface()`. If valid, it's activated and an instance is imported.
2. If `MetaProcess::PrefersGlobalExecution()` is true or no view is available, executes in the global context.
3. If `MetaProcess::PrefersGlobalExecution()` is false and a view is available, executes on the current view.
4. Throws a runtime exception if execution cannot proceed.
```

--------------------------------

### Get Alignment Origin

Source: https://pixinsight.com/developer/pcl/doc/html/DrizzleData_8h_source.html

Retrieves the alignment origin point as a DPoint object. No specific setup is required.

```cpp
const DPoint& AlignmentOrigin() const
{
  return m_alignmentOrigin;
}
```

--------------------------------

### Parallel MinMax Calculation Setup

Source: https://pixinsight.com/developer/pcl/doc/html/Image_8h_source.html

Initializes and configures data structures for parallel MinMax analysis. Determines optimal thread distribution based on image dimensions and processing capabilities.

```cpp
bool useAffinity = m_parallel && Thread::IsRootThread();

double low, high;
size_type count = 0;
{
Array<size_type> L;
{
Thread::PerformanceAnalysisData data;
data.algorithm = PerformanceAnalysisAlgorithm::MinMax;
data.length = N;
data.overheadLimit = 32768;
data.itemSize = BytesPerSample();
data.floatingPoint = IsFloatSample();
L = OptimalThreadRows( r.Height(), r.Width(), maxProcessors, N/Thread::OptimalNumberOfThreads( data )/*overheadLimitPx*/ );
}
ReferenceArray<MinMaxThread> threads;
for ( int i = 0, n = 0; i < int( L.Length() ); n += int( L[i++] ) )
threads << new MinMaxThread( *this, r, firstChannel, lastChannel, n, n + int( L[i] ) );

if ( threads.Length() > 1 )
{
int i = 0;
for ( MinMaxThread& thread : threads )
thread.Start( ThreadPriority::DefaultMax, useAffinity ? i++ : -1 );
for ( MinMaxThread& thread : threads )
thread.Wait();
}
else
threads[0].Run();

sample slow = 0, shigh = 0;
for ( size_type i = 0; i < threads.Length(); ++i )
if ( threads[i].count > 0 )
{
slow = threads[i].min;
shigh = threads[i].max;
count = threads[i].count;
while ( ++i < threads.Length() )
if ( threads[i].count > 0 )
{
if ( threads[i].min < slow )
slow = threads[i].min;
if ( shigh < threads[i].max )
shigh = threads[i].max;
count += threads[i].count;
}
break;
}

threads.Destroy();

low = double( slow );
high = double( shigh );
}
```

--------------------------------

### Constructor Documentation

Source: https://pixinsight.com/developer/pcl/doc/html/classpcl_1_1LanczosInterpolation.html

Details on the constructors for the LanczosInterpolation class.

```APIDOC
## Constructor & Destructor Documentation

### ◆ LanczosInterpolation() [1/2]
```cpp
template<typename T >
pcl::LanczosInterpolation< T >::LanczosInterpolation (
    int  _n_ = 3,
    float  _clamp_ = __PCL_LANCZOS_CLAMPING_THRESHOLD,
    bool  _useLUT_ = Default::UseLUT( (T*)0 )
)
```
inline
Constructs a LanczosInterpolation instance.

**Parameters**

*   **n** (int) - Filter order (n >= 1). The Lanczos filter interpolates from the nearest (2*n)^2 mapped source pixels for each interpolation point. The default filter order is 3, so the interpolation uses a neighborhood of 36 pixels by default.
*   **clamp** (float) - Clamping threshold. Clamping is applied to fix undershoot (aka ringing) artifacts. A value of this parameter within the [0,1] range enables clamping: The lower the clamping threshold, the more aggressive deringing effect is achieved. A negative threshold value disables the clamping feature. The default value is 0.3. For more information, refer to the documentation for the SetClampingThreshold( float ) member function.
*   **useLUT** (bool) - If true, the interpolation will use a precomputed LUT of function values at discrete intervals. This greatly improves performance, increasing execution speed by about a factor of 2. In current PCL versions, the Lanczos functions are sampled at 0.00025 px resolution, which provides an interpolation accuracy of about 1.0e-07. This is valid for interpolation of 32-bit floating point data, but can be insufficient for 32-bit integers and double precision, depending on the application. If this parameter is false, the interpolation will compute actual function values for each interpolation point. This parameter is true by default for the uint8, int8, uint16, int16, and float template specializations; false by default for other types.

Definition at line 197 of file LanczosInterpolation.h.

### ◆ LanczosInterpolation() [2/2]
```cpp
template<typename T >
pcl::LanczosInterpolation< T >::LanczosInterpolation (
    const LanczosInterpolation< T > &
)
```
default
Copy constructor.
```

--------------------------------

### Get CFA Source Pattern

Source: https://pixinsight.com/developer/pcl/doc/html/DrizzleData_8h_source.html

Retrieves the current CFA source pattern string. No specific setup is required.

```cpp
const String& CFASourcePattern() const
{
  return m_cfaSourcePattern;
}
```

--------------------------------

### ImageWindow - Construction and Destruction

Source: https://pixinsight.com/developer/pcl/doc/html/classpcl_1_1ImageWindow-members.html

Details on how to create and manage ImageWindow instances, including default constructors and copy/move semantics.

```APIDOC
## POST /websites/pixinsight/imagewindow

### Description
Creates and initializes an ImageWindow object.

### Method
POST

### Endpoint
/websites/pixinsight/imagewindow

### Parameters
#### Request Body
- **width** (int) - Optional - The width of the image window. Defaults to system default.
- **height** (int) - Optional - The height of the image window. Defaults to system default.
- **numberOfChannels** (int) - Optional - The number of color channels. Defaults to 1.
- **bitsPerSample** (int) - Optional - Bits per sample. Defaults to 32.
- **floatSample** (bool) - Optional - Indicates if the sample format is floating-point. Defaults to true.
- **color** (bool) - Optional - Indicates if the image is color. Defaults to false.
- **initialProcessing** (bool) - Optional - Indicates if initial processing should be performed. Defaults to true.
- **id** (string) - Optional - A unique identifier for the image window.

### Request Example
```json
{
  "width": 800,
  "height": 600,
  "numberOfChannels": 3,
  "bitsPerSample": 16,
  "floatSample": false,
  "color": true,
  "id": "MyImageWindow"
}
```

### Response
#### Success Response (200)
- **imageId** (string) - The identifier of the newly created ImageWindow.

#### Response Example
```json
{
  "imageId": "unique-window-id-12345"
}
```

## DELETE /websites/pixinsight/imagewindow/{imageId}

### Description
Destroys and cleans up an ImageWindow object.

### Method
DELETE

### Endpoint
/websites/pixinsight/imagewindow/{imageId}

### Parameters
#### Path Parameters
- **imageId** (string) - Required - The identifier of the ImageWindow to destroy.

### Request Example
None

### Response
#### Success Response (200)
Indicates successful destruction of the ImageWindow.

#### Response Example
```json
{
  "status": "success",
  "message": "ImageWindow destroyed successfully."
}
```
```

--------------------------------

### PCL Class List Example

Source: https://pixinsight.com/developer/pcl/doc/html/classpcl_1_1GroupBox.html

An excerpt from the PCL class list, showing a sample of class names starting with 'A' and 'B'.

```APIDOC
## PCL Class List Example

### Description
Sample of classes within the PCL.

### Classes starting with 'A'
- AbstractFFT
- AbstractFFT2D
- AbstractImage
- Action
- ActionInfo
- AdaptiveLocalFilter
- AES256
- AkimaInterpolation
- AlignedAllocator
- Allocator
- AlphaTrimmedMeanFilter
- AngleConversionOptions
- APASSDatabaseFile
- APASSStarData
- Argument
- Array
- Association
- AstrometricMetadata
- AstrometricReprojection
- AtomicInt
- ATrousWaveletTransform
- AutoLock
- AutoLockCounter
- AutoPointer
- AutoPointerCloner
- AutoReentrancyGuard
- AutoStatusCallbackRestorer
- AutoViewLock
- AutoViewWriteLock

### Classes starting with 'B'
- BayerFilterBGGR
- BayerFilterGBRG
- BayerFilterGRBG
- BayerFilterRGGB
- BicubicBSplineInterpolation
- BicubicBSplinePixelInterpolation
- BicubicFilterInterpolation
- BicubicFilterPixelInterpolation
- BicubicInterpolation
- BicubicInterpolationBase
- BicubicPixelInterpolation
- BicubicSplineInterpolation
- BicubicSplinePixelInterpolation
- BidimensionalInterpolation
- BidirectionalImageTransformation
- BidirectionalIterator
- BilinearInterpolation
- BilinearPixelInterpolation
- Bitmap
- BitmapBox
- BitmapStructure
- BoxStructure
- Brush
- Button
- CanvasColor
- CatmullRomSplineFilter
- CaughtException
- CharTraits
- CheckBox
- Cipher
- CircularStructure
- CodeEditor
- ColorComboBox
- ColorFilterArray
- ComboBox
- Complex
- ComplexPixelTraits
- Compression
- ConicalGradientBrush
- ConsistentlyDefined
- Console
- Const
- Container
- Control
- Convolution
- Crop
- CryptographicHash
- CryptographicHashFactory
- CubicBSplineFilter
- CubicFilter
- CubicSplineInterpolation
- CUDADevice
- Cursor
- Daubechies10Filter
- Daubechies12Filter
```

--------------------------------

### StartProgram

Source: https://pixinsight.com/developer/pcl/doc/html/ExternalProcess_8h_source.html

Static method to initiate the execution of an external program.

```APIDOC
## static pid_type StartProgram(const String &program, const StringList &arguments, const String &workingDirectory)

### Description
Starts an external program with optional arguments and a specified working directory.

### Parameters
#### Request Body
- **program** (String) - Required - The path to the executable.
- **arguments** (StringList) - Optional - List of command-line arguments.
- **workingDirectory** (String) - Optional - The directory in which the process should run.

### Response
- **pid_type** (integer) - The process ID of the started program.
```

--------------------------------

### Get Processes by Category (C++)

Source: https://pixinsight.com/developer/pcl/doc/html/Process_8h_source.html

Retrieves an array of all installed processes belonging to a specific category. This is a static method of the Process class.

```cpp
static Array<Process> ProcessesByCategory( const IsoString::ustring_base& category )
{
return ProcessesByCategory( IsoString( category ) );
}
```

--------------------------------

### Begin() and begin() Methods

Source: https://pixinsight.com/developer/pcl/doc/html/classpcl_1_1Array.html

Provides iterators to the beginning of the array, supporting both mutable and const access.

```APIDOC
## Begin() [1/2]

### Description
Returns a mutable iterator located at the beginning of this array.

### Method
`iterator Begin()`

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **iterator** - A mutable iterator to the beginning of the array.

#### Response Example
None
```

```APIDOC
## begin() [1/2]

### Description
STL-compatible iteration. Equivalent to Begin().

### Method
`iterator begin()`

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **iterator** - A mutable iterator to the beginning of the array.

#### Response Example
None
```

```APIDOC
## Begin() [2/2]

### Description
Returns an immutable iterator located at the beginning of this array.

### Method
`const_iterator Begin() const noexcept`

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **const_iterator** - A const iterator to the beginning of the array.

#### Response Example
None
```

```APIDOC
## begin() [2/2]

### Description
STL-compatible iteration. Equivalent to Begin() const.

### Method
`const_iterator begin() const noexcept`

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **const_iterator** - A const iterator to the beginning of the array.

#### Response Example
None
```

--------------------------------

### ImageWindow - Opening and Initialization

Source: https://pixinsight.com/developer/pcl/doc/html/ImageWindow_8h_source.html

Methods for opening and initializing ImageWindow objects.

```APIDOC
## pcl::ImageWindow::Open

### Description
Opens an ImageWindow from a given URL.

### Method
static Array< ImageWindow >

### Parameters
#### Path Parameters
- **url** (const String &) - Description: The URL of the image to open.
- **id** (const IsoString &) - Optional - Description: An identifier for the ImageWindow. Defaults to an empty IsoString.
- **formatHints** (const IsoString &) - Optional - Description: Hints for the image format. Defaults to an empty IsoString.
- **asCopy** (bool) - Optional - Description: Whether to open the image as a copy. Defaults to false.
- **allowMessages** (bool) - Optional - Description: Whether to allow messages during opening. Defaults to true.

### Endpoint
N/A (static method)
```

--------------------------------

### Get Initial Rotation Angle

Source: https://pixinsight.com/developer/pcl/doc/html/PolarTransform_8h_source.html

Retrieves the initial rotation angle in radians for the polar transform. This value defines the starting point of the angular sweep.

```cpp
float InitialRotation() const
{
return m_initialAngle;
}
```

--------------------------------

### Initialize

Source: https://pixinsight.com/developer/pcl/doc/html/classpcl_1_1StatusMonitor.html

Initializes the status monitor to start a new monitoring procedure.

```APIDOC
## void Initialize(const String &info, size_type count = 0)

### Description
Initializes this status monitor to start a new monitoring procedure. If a zero total progress count is specified, the monitor is unbounded.

### Parameters
- **info** (String) - Required - Progress information.
- **count** (size_type) - Optional - Total progress count.
```

--------------------------------

### Get Scaled UI Resource Path

Source: https://pixinsight.com/developer/pcl/doc/html/group__ui__scaling__functions.html

Returns a UI resource path scaled for a given resource scaling factor. For example, a factor of 1.5 might append '/1.5/' to the path.

```cpp
String pcl::UIScaledResource(double _scalingFactor_, R _resource_)
```

--------------------------------

### Get Scaled UI Resource Path for Index

Source: https://pixinsight.com/developer/pcl/doc/html/group__ui__scaling__functions.html

Returns a UI resource path scaled for a given resource scaling index. For example, index 3 (factor 2.5) might append '/2.5/' to the path.

```cpp
String pcl::UIScaledResourceForIndex(int _index_, R _resource_)
```

--------------------------------

### Declare PMINI Entry Point

Source: https://pixinsight.com/developer/pcl/doc/html/group__module__entry__points.html

The InitializePixInsightModule function is required for module installation and establishing bidirectional communication with the core application.

```cpp
PCL_MODULE_EXPORT uint32 InitializePixInsightModule( api_handle hModule, function_resolver R, uint32 apiVersion, void* reserved );
```

--------------------------------

### Constructor Documentation

Source: https://pixinsight.com/developer/pcl/doc/html/classpcl_1_1GenericImage_1_1sample__iterator.html

Details on the various constructors available for the sample_iterator class.

```APIDOC
## Constructor & Destructor Documentation

### ◆ sample_iterator() [1/4]
```cpp
template<class P >
| pcl::GenericImage< P >::sample_iterator::sample_iterator | ( | | ) |
```
default
Default constructor. Initializes an invalid iterator.

### ◆ sample_iterator() [2/4]
```cpp
template<class P >
| pcl::GenericImage< P >::sample_iterator::sample_iterator | ( | image_type & _image_ , int _channel_ = -1 )
```
inline
Constructs a mutable pixel sample iterator for one channel of an image.

Parameters:
- **image**: The image to iterate.
- **channel**: Channel index. If this parameter is a negative integer, then this object will be initialized to iterate on the currently selected channel of the _image_. If an invalid (i.e., nonexistent) channel index is specified, then the resulting iterator will also be invalid, with an empty iteration range. The default value is -1.
Definition at line 391 of file Image.h.

### ◆ sample_iterator() [3/4]
```cpp
template<class P >
| pcl::GenericImage< P >::sample_iterator::sample_iterator | ( | image_type & _image_ , sample * _i_ , sample * _j_ )
```
inline
Constructs a mutable pixel sample iterator for a range of contiguous pixel samples of an image.

Parameters:
- **image**: The image to iterate.
- **i**: Pointer to the first pixel sample in the iteration range. The iterator will be initialized to access this pixel sample just after construction.
- **j**: End of the iteration range. The iterator will be invalid when it reaches (or surpasses) this point.

Note:
Both iteration limits _i_ and _j_ must be pointers to pixel samples in the _same_ channel of the specified _image_.
Definition at line 418 of file Image.h.

### ◆ sample_iterator() [4/4]
```cpp
template<class P >
| pcl::GenericImage< P >::sample_iterator::sample_iterator | ( | const sample_iterator & | )
```
default
Copy constructor.
```

--------------------------------

### Get Directory Dialog

Source: https://pixinsight.com/developer/pcl/doc/html/functions_d.html

APIs for the get directory dialog.

```APIDOC
## GetDirectoryDialog

### Description
Represents a dialog for selecting a directory.

### Method
N/A (Class Definition)

### Endpoint
N/A
```

--------------------------------

### Set Observation Start Time

Source: https://pixinsight.com/developer/pcl/doc/html/AstrometricMetadata_8h_source.html

Sets the observation start time.

```cpp
void SetObservationStartTime( TimePoint startTime )
{
    m_obsStartTime = startTime;
}
```

--------------------------------

### QuadTree Build Method (from points)

Source: https://pixinsight.com/developer/pcl/doc/html/QuadTree_8h_source.html

Builds the QuadTree from a list of points. It first determines the bounding rectangle of all points and then recursively builds the tree structure. Parameters for bucket capacity and epsilon can be provided.

```cpp
void Build( const point_list& points,
 int bucketCapacity = __PCL_QUADTREE_DEFAULT_BUCKET_CAPACITY,
 double epsilon = __PCL_QUADTREE_DEFAULT_EPSILON )
{
 Clear();
 m_bucketCapacity = Max( 1, bucketCapacity );
 m_epsilon = Max( 2*std::numeric_limits<coordinate>::epsilon(), epsilon );

 if ( !points.IsEmpty() )
 {
 component x = points[0][0];
 component y = points[0][1];
 rectangle rect( x, y, x, y );
 for ( const point& p : points )
 {
 x = p[0];
 y = p[1];
 if ( x < rect.x0 )
 rect.x0 = x;
 if ( y < rect.y0 )
 rect.y0 = y;
 if ( x > rect.x1 )
 rect.x1 = x;
 if ( y > rect.y1 )
 rect.y1 = y;
 }
 m_root = BuildTree( rect, points );
 }
}
```

--------------------------------

### Module Installation Modes

Source: https://pixinsight.com/developer/pcl/doc/html/MetaModule_8h_source.html

Enumeration defining the operational mode of a module during installation.

```cpp
752 namespace InstallMode
753 {
754 enum value_type
755 {
756 FullInstall, // Normal, full installation
757 QueryModuleInfo, // Temporary load to gather module properties
758 VerifyModule // Temporary load to verify module integrity
759 };
760 }
```

--------------------------------

### Register Process Started Handler

Source: https://pixinsight.com/developer/pcl/doc/html/group__external__process__event__handlers.html

Registers a handler to be called when the ExternalProcess instance has started.

```cpp
void pcl::ExternalProcess::OnStarted (process_event_handler handler, Control &receiver);
```

--------------------------------

### virtual void Init()

Source: https://pixinsight.com/developer/pcl/doc/html/classpcl_1_1XISFLogHandler.html

Initializes the log handler object at the beginning of an XISF file transaction.

```APIDOC
## virtual void Init()

### Description
Initializes this log handler object. This function is called by internal XISFReader and XISFWriter engines at the beginning of an XISF file transaction.

### Parameters
- **filePath** (const String &) - Required - Full path to the XISF file about to be loaded or generated.
- **writing** (bool) - Required - True at the beginning of a file generation process; false at the beginning of a file loading process.
```

--------------------------------

### Initialize

Source: https://pixinsight.com/developer/pcl/doc/html/classpcl_1_1ProcessInterface.html

Deprecated interface initialization routine.

```APIDOC
## Initialize

### Description
Deprecated routine for creating child controls. Use the deferred initialization technique via Launch() instead.

### Method
virtual void
```

--------------------------------

### Class Members - Variables starting with 'a'

Source: https://pixinsight.com/developer/pcl/doc/html/functions_vars_a.html

Lists class members that are variables and start with the letter 'a'.

```APIDOC
## Class Members - Variables starting with 'a'

### Variables
- **a** (pcl::LinearFit, pcl::ObserverPosition, pcl::OsculatingElements)
- **A** (pcl::PSFData)
- **A1** (pcl::EphemerisObject, pcl::SerializableEphemerisObjectData)
- **A2** (pcl::EphemerisObject, pcl::SerializableEphemerisObjectData)
- **A3** (pcl::EphemerisObject, pcl::SerializableEphemerisObjectData)
- **adev** (pcl::LinearFit)
- **Ai** (pcl::GenericGaussJordan< T >)
- **algorithm** (pcl::Thread::PerformanceAnalysisData)
- **aliases** (pcl::ProcessParameter::EnumerationElement)
- **alpha** (pcl::StarPosition)
- **altobs** (pcl::WCSKeywords)
- **aperture** (pcl::ImageOptions)
- **area** (pcl::StarDetector::Star)
- **attributes** (pcl::FindFileInfo)
- **authors** (pcl::EphemerisMetadata, pcl::XPSD::Metadata)
- **autoMetadata** (pcl::XISFOptions)
- **avgDev** (pcl::ImageStatistics::Data)
```

--------------------------------

### Initialize

Source: https://pixinsight.com/developer/pcl/doc/html/classpcl_1_1ProcessImplementation.html

Performs special initialization of process instances after construction.

```APIDOC
## Initialize

### Description
Initializes this process instance after construction. This function is called by the PixInsight core application if MetaProcess::NeedsInitialization() returns true.
```

--------------------------------

### Profile Configuration Methods

Source: https://pixinsight.com/developer/pcl/doc/html/ICCProfileTransformation_8h_source.html

Methods for setting source, proofing, and target profiles using paths, objects, or handles.

```cpp
void SetSourceProfile( const String& profilePath );
void SetSourceProfile( const ICCProfile& profile );
void SetSourceProfile( const ICCProfile::handle profileHandle );

void SetProofingProfile( const String& profilePath );
void SetProofingProfile( const ICCProfile& profile );
void SetProofingProfile( const ICCProfile::handle profileHandle );

void SetTargetProfile( const String& profilePath );
void SetTargetProfile( const ICCProfile& profile );
void SetTargetProfile( const ICCProfile::handle profileHandle );
```

--------------------------------

### Namespace Members - Typedefs starting with 'I'

Source: https://pixinsight.com/developer/pcl/doc/html/namespacemembers_i.html

Lists typedefs within the PCL namespaces that start with the letter 'I'.

```APIDOC
## Namespace Members - Typedefs starting with 'I'

### Description
This section lists typedefs within the PCL namespaces that start with the letter 'I'.

### Method
N/A (Documentation Index)

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
N/A

## Typedefs
- **int16** : `pcl`
- **int32** : `pcl`
- **int64** : `pcl`
- **int8** : `pcl`
```

--------------------------------

### IPCStart

Source: https://pixinsight.com/developer/pcl/doc/html/classpcl_1_1MetaProcess.html

Handles a start process IPC message.

```APIDOC
## IPCStart

### Description
Handles a start process IPC message. This function will never be called unless the CanProcessIPCMessages() member function is reimplemented to return true.

### Parameters
- **instance** (int) - Required - The instance number of the running PixInsight core application.
- **messageUID** (IsoString) - Required - Unique identifier of the IPC message.
- **parameters** (String) - Required - A string in UTF-16 format with process-specific parameters.
```
Tokens:
Raw