mia-3dimagecreator(1)

📦
version 2.4.7 · 2 versions
, in debian bookworm, ubuntu resolute, ubuntu stonking

💖 mia-3dimagecreator — the manual, but make it make sense 💖

okay bestie, so this is the mia-3dimagecreator page from section 1 of the General Commands Manual (USER COMMANDS girlies, we see you 👑). It's a lil program that makes 3D images outta thin air. Sit down, grab a strawberry 🍓, and let's get into it.

✨ NAME ✨

mia-3dimagecreator — literally just. create a synthetic 3D image. that's the whole job. that's the assignment and she ate 💅

🦋 SYNOPSIS 🦋

mia-3dimagecreator -o <out-file> [options]

that's it. give her somewhere to put the image, and optionally tell her a lil more 🌸

🌈 DESCRIPTION 🌈

so mia-3dimagecreator creates a 3D image that contains an object. And where does the object come from? From one of the object creator plug-ins (that's the creator/3dimage fam). So like, you pick a creator, it fills your image with a whole object. no cap, that's the vibe 🧚

💅 OPTIONS 💅

here's where it gets juicy. every flag, every default, all of it, no skipping, periodt.

  • -o, --out-file=(output, required); io — the output file for the object you're creating. ⚠️ it's required, so no output file = no image, sad girl hours. For which file types she actually supports, go peek at PLUGINS:3dimage/io 👇
  • -s, --size=[128,128,128] — the size of the object. default is [128,128,128], cute and cubic ✨
  • -r, --repn=ubyte — the input pixel type. default ubyte. your options, in her exact words:
    • bit — binary data
    • sbyte — signed 8 bit
    • ubyte — unsigned 8 bit
    • sshort — signed 16 bit
    • ushort — unsigned 16 bit
    • sint — signed 32 bit
    • uint — unsigned 32 bit
    • slong — signed 64 bit
    • ulong — unsigned 64 bit
    • float — floating point 32 bit
    • double — floating point 64 bit
    • none — no pixel type defined
  • -j, --object=sphere — which object should be created. default is sphere 🔮. For which plugins are supported, check PLUGINS:3dimage/creator below!

🎀 Help & Info 🎀

the "wait, how do I use this" corner. very girl-helping-girl of her 🫶

  • -V, --verbose=warning — verbosity of output: she prints messages of the given level and higher priorities. The supported priorities, starting at the lowest level, are:
    • trace — Function call trace
    • debug — Debug output
    • info — Low level messages
    • message — Normal messages
    • warning — Warnings
    • fail — Report test failures
    • error — Report errors
    • fatal — Report only fatal errors
  • --copyright — print copyright information 📜
  • -h, --help — print this help
  • -?, --usage — print a short help
  • --version — print the version number and exit

🔥 Processing 🔥

  • --threads=-1 — Maxiumum number of threads to use for processing (yes bestie that typo is canon, we don't touch it 💀). This number should be lower or equal to the number of logical processor cores in the machine. And -1 means automatic estimation, aka she figures it out herself, main character energy 👑

💜 PLUGINS: 3dimage/creator 💜

these are the object creators!! the ones that actually sculpt your image.

  • lattic — 3D lattic creation program. supported parameters are:
    • fx = 16; float in [1, 64] — frequency in x-dir.
    • fy = 16; float in [1, 64] — frequency in y-dir.
    • fz = 16; float in [1, 64] — frequency in z-dir.
  • sphere — 3D sphere creation program. supported parameters are:
    • f = 2; float in [0, 10] — spherical change frequency.
    • p = 2; float in [0.1, 100] — spherical shape parameter (2.0 = sphere).
ngl the lattic frequency defaults are all 16 and the ranges are [1, 64] — respect the bounds or she will not be having it 🙈

🌸 PLUGINS: 3dimage/io 🌸

the ✨file format✨ roster. here's who can read/write what, extensions and element types included, verbatim, because details are the whole point bestie.

  • analyze — Analyze 7.5 image
    • Recognized file extensions: .HDR, .hdr
    • Supported element types: unsigned 8 bit, signed 16 bit, signed 32 bit, floating point 32 bit, floating point 64 bit
  • datapool — Virtual IO to and from the internal data pool
    • Recognized file extensions: .@
  • dicom — Dicom image series as 3D
    • Recognized file extensions: .DCM, .dcm
    • Supported element types: signed 16 bit, unsigned 16 bit
  • hdf5 — HDF5 3D image IO
    • Recognized file extensions: .H5, .h5
    • Supported element types: binary data, signed 8 bit, unsigned 8 bit, signed 16 bit, unsigned 16 bit, signed 32 bit, unsigned 32 bit, signed 64 bit, unsigned 64 bit, floating point 32 bit, floating point 64 bit
  • inria — INRIA image
    • Recognized file extensions: .INR, .inr
    • Supported element types: signed 8 bit, unsigned 8 bit, signed 16 bit, unsigned 16 bit, signed 32 bit, unsigned 32 bit, floating point 32 bit, floating point 64 bit
  • mhd — MetaIO 3D image IO using the VTK implementation (experimental). 🧪
    • Recognized file extensions: .MHA, .MHD, .mha, .mhd
    • Supported element types: signed 8 bit, unsigned 8 bit, signed 16 bit, unsigned 16 bit, signed 32 bit, unsigned 32 bit, floating point 32 bit, floating point 64 bit
  • nifti — NIFTI-1 3D image IO. The orientation is transformed in the same way like it is done with 'dicomtonifti --no-reorder' from the vtk-dicom package.
    • Recognized file extensions: .NII, .nii
    • Supported element types: signed 8 bit, unsigned 8 bit, signed 16 bit, unsigned 16 bit, signed 32 bit, unsigned 32 bit, signed 64 bit, unsigned 64 bit, floating point 32 bit, floating point 64 bit
  • vff — VFF Sun raster format
    • Recognized file extensions: .VFF, .vff
    • Supported element types: unsigned 8 bit, signed 16 bit
  • vista — Vista 3D
    • Recognized file extensions: .-, .V, .VISTA, .v, .vista
    • Supported element types: binary data, signed 8 bit, unsigned 8 bit, signed 16 bit, unsigned 16 bit, signed 32 bit, unsigned 32 bit, floating point 32 bit, floating point 64 bit
  • vti — 3D image VTK-XML in- and output (experimental). 🧪
    • Recognized file extensions: .VTI, .vti
    • Supported element types: signed 8 bit, unsigned 8 bit, signed 16 bit, unsigned 16 bit, signed 32 bit, unsigned 32 bit, floating point 32 bit, floating point 64 bit
  • vtk — 3D VTK image legacy in- and output (experimental). 🧪
    • Recognized file extensions: .VTK, .VTKIMAGE, .vtk, .vtkimage
    • Supported element types: signed 8 bit, unsigned 8 bit, signed 16 bit, unsigned 16 bit, signed 32 bit, unsigned 32 bit, floating point 32 bit, floating point 64 bit

🌟 EXAMPLE 🌟

okay so the task: create an image output.v of size <64,128,256> that contains a lattic with frequencys 8, 16, and 4 in x, y and, z-direction respectively. iconic brief, honestly.

mia-3dimagecreator -o lattic.v -j lattic:fx=8,fy=16,fz=4 -s
       "<64,128,256>"

see how the -j takes the plugin plus its params after a colon? that's the whole trick, iykyk 😌

👑 AUTHOR(s) 👑

Gert Wollny — shoutout to the author, we love a legend fr fr 🫶

This software is Copyright (c) 1999‐2015 Leipzig, Germany and Madrid, Spain. It comes with ABSOLUTELY NO WARRANTY (read it again bestie, no safety net, none 😭) and you may redistribute it under the terms of the GNU GENERAL PUBLIC LICENSE Version 3 (or later). For more information run the program with the option '--copyright'.

aaaand that's the whole page!! this was the mia-3dimagecreator(1) manpage from the USER COMMANDS manual section, at version v2.4.7 — go make something sparkly, you've got this 🦋✨💖

📦 where this page comes from