geo3d.core.base
===============

.. py:module:: geo3d.core.base


Classes
-------

.. autoapisummary::

   geo3d.core.base.Component
   geo3d.core.base.Reader
   geo3d.core.base.Writer
   geo3d.core.base.Filter


Module Contents
---------------

.. py:class:: Component(subtype: Optional[str] = None, **kwargs: Any)

   Bases: :py:obj:`abc.ABC`


   A base class `Component` to be used in the definition of pdal components (readers, filters, and writers).


   .. py:attribute:: subtype
      :value: None



   .. py:attribute:: _kwargs


   .. py:attribute:: inputs
      :type:  Optional[List[str]]
      :value: None



   .. py:attribute:: outputs
      :type:  Optional[str]
      :value: None



   .. py:attribute:: _block_type


   .. py:attribute:: config


   .. py:method:: block_type() -> str
      :abstractmethod:


      Return the block type of the component.



   .. py:method:: _inner_dict() -> Dict[str, Any]

      Create a dictionary that lists the actual inputs of the component.



   .. py:method:: _outer_dict() -> Dict[str, Any]

      Create a dictionary that lists the actual outputs of the component.



   .. py:method:: _body_dict() -> Dict[str, Any]
      :abstractmethod:


      Create a dictionary that lists the actual arguments of the component.



   .. py:method:: _create_dict() -> Dict[str, Any]

      Create a config dictionary by merging the inner, outer, and body dictionaries.



   .. py:method:: _update_dict() -> None

      Update the attribute config.



   .. py:method:: set_output(tag: str) -> None

      Set the output of the component.



   .. py:method:: set_input(tags: list) -> None

      Set the inputs of the component.



   .. py:method:: receive_from(components: List[Component]) -> None

      Set the component to receive from another component.



   .. py:method:: __str__() -> str

      Special method for representing the instance as a string.



.. py:class:: Reader(subtype: Optional[str] = None, **kwargs: Any)

   Bases: :py:obj:`Component`


   A class Reader that defines a pdal reader component.


   .. py:method:: block_type() -> str

      Return the block type of the component.



   .. py:method:: _body_dict() -> Dict[str, Any]

      Build the body dictionary of the component.



.. py:class:: Writer(subtype: Optional[str] = None, **kwargs: Any)

   Bases: :py:obj:`Component`


   Class Writer for defining pdal writer component.


   .. py:method:: block_type() -> str

      Return the block type of the component.



   .. py:method:: _body_dict() -> Dict[str, Any]

      Build the body dictionary of the component.



.. py:class:: Filter(subtype: Optional[str] = None, **kwargs: Any)

   Bases: :py:obj:`Component`


   Class Writer for defining pdal filter component.


   .. py:method:: block_type() -> str

      Return the block type of the component.



   .. py:method:: _body_dict() -> Dict[str, Any]

      Build the body dictionary of the component.