isofit.utils.segment
====================

.. py:module:: isofit.utils.segment


Functions
---------

.. autoapisummary::

   isofit.utils.segment.segment_chunk
   isofit.utils.segment.segment


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

.. py:function:: segment_chunk(lstart, lend, in_file, nodata_value, npca, segsize, logfile=None, loglevel='INFO')

   Segment a small chunk of the image

   :param lstart: starting position in image file
   :param lend: stopping position in image file
   :param in_file: file path to segment
   :param nodata_value: value to ignore
   :param npca: number of pca components to use
   :param segsize: mean segmentation size
   :param logfile: logging file name
   :param loglevel: logging level

   :returns: starting position in image file
             lend: stopping position in image file
             labels: labeled image chunk
   :rtype: lstart


.. py:function:: segment(spectra: tuple, nodata_value: float, npca: int, segsize: int, nchunk: int, n_cores: int = 1, ray_address: str = None, ray_redis_password: str = None, ray_temp_dir=None, ray_ip_head=None, logfile=None, loglevel='INFO')

   Segment an image using SLIC on a PCA.

   :param spectra: tuple of filepaths of image to segment and (optionally) output label file
   :param nodata_value: data to ignore in radiance image
   :param npca: number of pca components to use
   :param segsize: mean segmentation size
   :param nchunk: size of each image chunk
   :param n_cores: number of cores to use
   :param ray_address: ray address to connect to (for multinode implementation)
   :param ray_redis_password: ray password to use (for multinode implementation)
   :param ray_temp_dir: ray temp directory to reference
   :param ray_ip_head: ray ip head to reference (for multinode use)
   :param logfile: logging file to output to
   :param loglevel: logging level to use