PlotFolder
==========

.. currentmodule:: Stoner.folders

.. autoclass:: PlotFolder
   :show-inheritance:

   .. rubric:: Attributes Summary

   .. autosummary::

      ~PlotFolder.basenames
      ~PlotFolder.clone
      ~PlotFolder.debug
      ~PlotFolder.defaults
      ~PlotFolder.depth
      ~PlotFolder.directory
      ~PlotFolder.each
      ~PlotFolder.files
      ~PlotFolder.groups
      ~PlotFolder.instance
      ~PlotFolder.is_empty
      ~PlotFolder.key
      ~PlotFolder.layout
      ~PlotFolder.loaded
      ~PlotFolder.loader
      ~PlotFolder.ls
      ~PlotFolder.lsgrp
      ~PlotFolder.metadata
      ~PlotFolder.mindepth
      ~PlotFolder.not_empty
      ~PlotFolder.not_loaded
      ~PlotFolder.objects
      ~PlotFolder.pattern
      ~PlotFolder.root
      ~PlotFolder.setas
      ~PlotFolder.shape
      ~PlotFolder.trunkdepth
      ~PlotFolder.type

   .. rubric:: Methods Summary

   .. autosummary::

      ~PlotFolder.add_group
      ~PlotFolder.all
      ~PlotFolder.append
      ~PlotFolder.clear
      ~PlotFolder.compress
      ~PlotFolder.concatenate
      ~PlotFolder.count
      ~PlotFolder.extend
      ~PlotFolder.extract
      ~PlotFolder.fetch
      ~PlotFolder.figure
      ~PlotFolder.file
      ~PlotFolder.filter
      ~PlotFolder.filterout
      ~PlotFolder.flatten
      ~PlotFolder.gather
      ~PlotFolder.get
      ~PlotFolder.getlist
      ~PlotFolder.group
      ~PlotFolder.index
      ~PlotFolder.insert
      ~PlotFolder.items
      ~PlotFolder.keep_latest
      ~PlotFolder.keys
      ~PlotFolder.make_name
      ~PlotFolder.on_load_process
      ~PlotFolder.plot
      ~PlotFolder.pop
      ~PlotFolder.popitem
      ~PlotFolder.prune
      ~PlotFolder.remove
      ~PlotFolder.reverse
      ~PlotFolder.save
      ~PlotFolder.select
      ~PlotFolder.setdefault
      ~PlotFolder.slice_metadata
      ~PlotFolder.sort
      ~PlotFolder.unflatten
      ~PlotFolder.unload
      ~PlotFolder.update
      ~PlotFolder.values
      ~PlotFolder.walk_groups
      ~PlotFolder.zip_groups

   .. rubric:: Attributes Documentation

   .. autoattribute:: basenames
   .. autoattribute:: clone
   .. autoattribute:: debug
   .. autoattribute:: defaults
   .. autoattribute:: depth
   .. autoattribute:: directory
   .. autoattribute:: each
   .. autoattribute:: files
   .. autoattribute:: groups
   .. autoattribute:: instance
   .. autoattribute:: is_empty
   .. autoattribute:: key
   .. autoattribute:: layout
   .. autoattribute:: loaded
   .. autoattribute:: loader
   .. autoattribute:: ls
   .. autoattribute:: lsgrp
   .. autoattribute:: metadata
   .. autoattribute:: mindepth
   .. autoattribute:: not_empty
   .. autoattribute:: not_loaded
   .. autoattribute:: objects
   .. autoattribute:: pattern
   .. autoattribute:: root
   .. autoattribute:: setas
   .. autoattribute:: shape
   .. autoattribute:: trunkdepth
   .. autoattribute:: type

   .. rubric:: Methods Documentation

   .. automethod:: add_group
   .. automethod:: all
   .. automethod:: append
   .. automethod:: clear
   .. automethod:: compress
   .. automethod:: concatenate
   .. automethod:: count
   .. automethod:: extend
   .. automethod:: extract
   .. automethod:: fetch
   .. automethod:: figure
   .. automethod:: file
   .. automethod:: filter
   .. automethod:: filterout
   .. automethod:: flatten
   .. automethod:: gather
   .. automethod:: get
   .. automethod:: getlist
   .. automethod:: group
   .. automethod:: index
   .. automethod:: insert
   .. automethod:: items
   .. automethod:: keep_latest
   .. automethod:: keys
   .. automethod:: make_name
   .. automethod:: on_load_process
   .. automethod:: plot
   .. automethod:: pop
   .. automethod:: popitem
   .. automethod:: prune
   .. automethod:: remove
   .. automethod:: reverse
   .. automethod:: save
   .. automethod:: select
   .. automethod:: setdefault
   .. automethod:: slice_metadata
   .. automethod:: sort
   .. automethod:: unflatten
   .. automethod:: unload
   .. automethod:: update
   .. automethod:: values
   .. automethod:: walk_groups
   .. automethod:: zip_groups