API reference

Autogenerated reference material for selected packages. Prefer these pages over duplicating signatures in README.md files.

• nornir_shared
  • Nornir Shared Package
• nornir_pools
  • Pool Creation
  • Dashboard pool load
  • Global pools
  • Pool Objects
  • Task Objects
  • Pool lifecycle
  • Optimization
  • ApplyOSThreadLimit()
  • ClosePools()
  • CloseProcessPools()
  • CloseThreadPools()
  • Enum
  • FastClosePools()
  • GetAndCreateProfileDataFileName()
  • GetAndCreateProfileDataPath()
  • GetGlobalClusterPool()
  • GetGlobalLocalMachinePool()
  • GetGlobalMultithreadingPool()
  • GetGlobalProcessPool()
  • GetGlobalSerialPool()
  • GetGlobalThreadPool()
  • GetLocalMachinePool()
  • GetMultithreadingPool()
  • GetParallelPythonPool()
  • GetProcessPool()
  • GetSerialPool()
  • GetThreadPool()
  • IPool
  • InstrumentedThreadPoolExecutor
  • IsParallelPythonAvailable()
  • MergeProfilerStats()
  • ParamSpec
  • PoolFactory
  • PoolKind
  • Protocol
  • ReleaseStagePools()
  • Task
  • WaitOnAllPools()
  • WaitOnProcessPools()
  • WaitOnThreadPools()
  • aggregate_profiler_data()
  • end_profiling()
  • get_or_create_shared_memory_manager()
  • init_pool_process()
  • invoke_with_profiler()
  • start_profiling()
• nornir_imageregistration
  • alignment_record
  • core
  • assemble
  • assemble_tiles
  • HasCuVS()
  • HasCupy()
  • IControlPoints
  • IDiscreteTransform
  • ITransform
  • ITransformChangeEvents
  • ITransformScaling
  • ITransformTranslation
• nornir_buildmanager
  • Named Arguments
  • Commands
  • Sub-commands
  • BuildParserRoot()
  • Execute()
  • ExecuteChain()
  • InitLogging()
  • SetupLogging()
  • TaskTimer
  • call_pipeline()
  • call_recover_import_meta_data()
  • call_recover_links()
  • call_repair_xml()
  • init_computational_library()
  • is_headless()
  • lowpriority()
  • print_help()
  • Pipeline and volume model modules
• nornir_volumecontroller API
  • CreateVolumeController()
  • Volume
  • GetChannels()
  • Scale
  • Volume
  • VolumeInterface
  • VolumeRegisteredChannel
  • CreateVolumeController()
  • BuildSectionChannelMap()
  • BuildVolumeTransformMap()
  • SectionsInBoundingBox()
• nornir_volumemodel API
  • Block
  • Channel
  • Data
  • DirectoryResource
  • ExternalResource
  • FileResource
  • Filter
  • Image
  • ImageSet
  • InputTransformPropertySet
  • Level
  • Load_Xml()
  • ModelBase
  • Named
  • Numbered
  • Save_Xml()
  • Scale
  • Section
  • TilePyramid
  • Transform
  • Volume
  • DirectoryResource
  • Named
  • Volume
  • Block
  • DirectoryResource
  • Named
  • DirectoryResource
  • Numbered
  • Section
  • Channel
  • DirectoryResource
  • Named
  • AxisScale
  • ModelBase
  • Scale
  • FileResource
  • InputTransformPropertySet
  • Transform
  • DirectoryResource
  • ExternalResource
  • FileResource
  • ModelBase
  • Named
  • Numbered
  • ChildElementObjects()
  • GetModelLoadFuncFromTag()
  • Load()
  • LoadModelObjectFromXmlPath()
  • LoadXmlElementFromPath()
  • ModelFromXMLElement()
  • Save()