Metadata-Version: 2.1
Name: ConcurrentImageRead
Version: 0.0.7
Summary: Read Image Directory or Image List simultaneously with multi-processing
Home-page: https://github.com/adityamangal1998/Concurrent-Image-Read.git
Author: Aditya Mangal
Author-email: adityamangal98@gmail.com
License: MIT
Description: # Concurrent-Image-Read
         <b>Concurrent-Image-Read</b> is a python module to read Image Files or Image List Concurrently with multi-threading
        <h1>Installation</h1>
        
        <h2>Dependencies</h2>
        <ul>
        <li>Python (>= 3.7)</li>
        <li>cv2 (>= 4.5)</li>
        <li>NumPy (>= 1.17)</li>
        <li>glob (>= 0.7)</li>
        <li>future (>= 0.18.2)</li>
        </ul>
        
        <h1>User installation</h1>
        <pre><code>pip install ConcurrentImageRead
        </code></pre>
        
        
        <h1>Source code</h1>
        You can check the latest sources with the command:
        <pre><code>git clone https://github.com/adityamangal1998/Concurrent-Image-Read.git
        </code></pre>
        
        <h1>Usage</h1>
        <h2>Default Parameters</h2>
        <ul><b>read function</b>
        <li>image_list = List or Numpy array or Single Path of image</li>
        <li>num_threads = Number of threads (default 3) <b>(optional)</b></li>
        <li>channel_type = BGR or RBG (default BGR) <b>(optional)</b></li>
        <li>root_path = String, Parent path for all files <b>(optional)</b></li>
        <li>grayscale = True or False <b>(optional)</b></li>
        <li>resize = List or Tuple resize scale in (width,height) <b>(optional)</b></li>
        <li>normalisation = True or False, Image array divide by 255 <b>(optional)</b></li>
        </ul>
        
        <ul><b>read_dir function</b>
        <li>dir_path = String, Path of Image Directory</li>
        <li>file_type = 'all' or 'PNG','JPG',...etc or ['JPG','PNG',...] <b>(case sensitive)</b> (default png)</li>
        <li>num_threads = Number of threads (default 3)</li>
        <li>channel_type = BGR or RBG (default BGR)</li>
        <li>sub_dir = Bool, Find all Images in all child directory also (default False)</li>
        <li>grayscale = True or False <b>(optional)</b></li>
        <li>normalisation = True or False, Image array divide by 255 <b>(optional)</b></li>
        </ul>
        
        <h2>With Image List</h2>
        You can check the latest sources with the command:
        <pre><code>import ConcurrentImageRead as CIR
        image_list = ['1.png','2.png','3.png']
        images = CIR.read(image_list,num_threads=3, channel_type='BGR')
        </code></pre>
        
        <h2>With Image Path</h2>
        <pre><code>import ConcurrentImageRead as CIR
        image_list = '1.png'
        images = CIR.read(image_list,num_threads=3, channel_type='BGR')
        </code></pre>
        
        <h2>With Directory Path</h2>
        <pre><code>import ConcurrentImageRead as CIR
        dir_path = 'data/images'
        images = CIR.read_dir(dir_path,file_type='png', num_threads=3, channel_type='BGR', sub_dir=False)
        </code></pre>
        
        
Platform: UNKNOWN
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Description-Content-Type: text/markdown
