Metadata-Version: 2.1
Name: gendc-python
Version: 0.2.6
Summary: GenDC Python package
Author-email: Momoko Kono <momoko.kono@fixstars.com>
License: MIT License
        
        Copyright (c) Olli-Pekka Heinisuo
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
Project-URL: Documentation, https://sensing-dev.github.io/doc/
Project-URL: Repository, https://github.com/Sensing-Dev/GenDC
Project-URL: Issues, https://github.com/Sensing-Dev/GenDCt/issues
Classifier: Development Status :: 3 - Alpha
Classifier: Programming Language :: Python
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE.txt

# gendc-python

The gendc descriptor comprises  main elements: the descriptor the container data 


descriptor includes the the container header, the component header, and the part header.

the container data includes all part data

##  GenDC Containers layout
- **Container Header**
  - **Component 1 Header (RGB Planar Intensity)**
    - Part 1 Header
    - Part 2 Header
    - Part 3 Header
  - **Component 2 Header (Range)**
    - Part 1 Header
  - **Component 3 Header (Metadata)**
    - Part 1 Header
      - Part 1 Data (Metadata Chunk)
- **Container Data**
  - Part 1 Data (Red plane)
  - Part 2 Data (Green plane)
  - Part 3 Data (Blue plane)
  - Part 1 Data (Range)
  - Part 1 Data (Metadata Chunk)

 **In this library, we reconstruct each element in following way:**

- **Container Header**
  - **Component 1 Header (RGB Planar Intensity)**
    - Part 1 Header
      - Part 1 Data (Red plane)
    - Part 2 Header
      - Part 2 Data (Green plane)
    - Part 3 Header
      - Part 3 Data (Blue plane)
  - **Component 2 Header (Range)**
    - Part 1 Header
      - Part 1 Data (Range)
  - **Component 3 Header (Metadata)**
    - Part 1 Header
      - Part 1 Data (Metadata Chunk)


## Quick start
```python
from gendc_python.gendc_separator import descriptor

gendc_container = descriptor.Container("binary_gendc_information")
```

## API

### Container
```
gendc_container = descriptor.Container("binary_gendc_information")
```

* `is_gendc_descriptor(binary_info)`: Checks if the descriptor in the binary data matches the specific signature for a GENDC descriptor.
  * Parameters:
    * binary_info (bytes): The binary data from which to load the signature.
  * Returns:
    * bool: True if the binary data is GenDC format

* `get_data_size()`: Retrieves the size in bytes of the data of the container.
  * Returns:
    * int: total size in bytes of the container data
* `get_descriptor_size()`: Retrieves the size in bytes of the descriptor part of the container.
  * Returns:
    * int: total size in bytes of the descriptor
* `get_container_size()`: Calculates the total size of the container by adding up data size and descriptor size.
  * Returns:
    * int: total size in bytes of the container 
* `get_component_count()`: Retrieves the count of components in the container.
  * Returns:
    * int: the count of components in the container.

*  `get_1st_component_idx_by_typeid(typeid)`: Finds the index of the first available component with the specified data type.
  * Parameters:
    * typeid (int): The target type ID to search for in components.
  * Returns:
    * int: The index of the first available component with the matching data type, or -1 if not found.

* `get_1st_component_idx_by_sourceid(sourceid)`: Finds the index of the first available component with the specified source ID.
  * Parameters:
    * sourceid (int): The target source ID to search for in components.
  * Returns:
    * int: The index of the first available component with the matching data type, or -1 if not found.

* `get_component_by_index(ith_component)`: Retrieves the component header at the specified index.
  * Parameters:
    * ith_component (int): The index of the component to retrieve.
  * Returns:
    * Component object: The component object at the specified index.

* `get_component_header_value(key, ith_component)`: Retrieves a specific value from a component's header based on a given key.
  * Parameters:
    * ith_component (int): The index of the component to retrieve.
    * key (str): The value from component header to retrieve.
  * Returns:
    * Any: The value associated with the key from the specified component's header..
* `get_part_header_value(key, ith_component, jth_part)`: Retrieves a specific value from a part's header within a component based on a given key.
  * Parameters:
    * ith_component (int): The index of the component to retrieve.
    * jth_part (int): The index of the part within the component.
    * key (str): The key of the value from part header to retrieve.
  * Returns:
    * Any: The value associated with the key from the specified part's header within the component.
* `get(key)`: General method to retrieve a specific value from a container's header based on a given key.
  * Parameters:
    * key (str): The key of the value from part header to retrieve.
  * Returns:
    * Any: The value associated with the key from container header.

### Component
* `get_part_count()`: Retrieves the count of parts in the component.
  * Parameters:
    * key (str): The key of the value from part header to retrieve.
  * Returns:
    * int: The number of parts.

* `get_part_by_index(jth_part)`: Retrieves a part based on its index.
  * Parameters:
    * jth_part (int): The index of the part to retrieve.
  * Returns:
    * Part Object: The part header at the specified index.

* `get(key)`: Retrieves a specific value from container header based on a given key.
  * Parameters:
    * key (str): The key of the value from part header to retrieve.
  * Returns:
    * Any: The value associated with the key from container header.

* `get_part_header_value(key, jth_part)`: Retrieves a specific value from a part's header based on a given key.
  * Parameters:
    * jth_part (int): The index of the part to retrieve.
  * Returns:
    * Any: The value associated with the key from part header.
* `get(key)`: General method to retrieve a specific value from current component header based on a given key.
  * Parameters:
    * key (str): The key of the value from current component header to retrieve.
  * Returns:
    * Any: The value associated with the key from current component header.

## Part

* `is_data_1D_image()`: Determines if the part data is a 1D image based on the header type.
  * Returns:
    * bool: True if the header type indicates a 1D image, otherwise False.
* `is_data_2D_image()`: Determines if the part data is a 2D image based on the header type.
  * Returns:
    * bool: True if the header type indicates a 2D image, otherwise False.
* `get_dimension()`: Retrieves the dimensions of the data.
  * Returns:
    * list: A list containing the dimensions of the part. Returns an empty list if neither.

* `get_data_size()`: Retrieves the size of the data.
  * Returns:
    * int: The size of the data part in bytes

* `get_data_offset()`: Retrieves the offset at which the data part starts within the binary file.
  * Returns:
    * int: The offset of the data part in bytes.

 * `get_data()`: Extracts and returns the data part based on its size and offset.
   * Returns:
     * bytes: The binary data of the part.

* `get(key)`: General method to retrieve a specific value from current part header based on a given key.
  * Parameters:
    * key (str): The key of the value from current part header to retrieve.
  * Returns:
    * Any: The value associated with the key from current part header.


## Reference

GenDC v1.1 by emva https://www.emva.org/wp-content/uploads/GenICam_GenDC_v1_1.pdf
