NT-MDT palette format: PHP parsing library

It is a color scheme for visualising SPM scans.

Application

["Nova", "Image Analysis", "NanoEducator"]

File extension

pal

KS implementation details

License: Unlicense

This page hosts a formal specification of NT-MDT palette format using Kaitai Struct. This specification can be automatically translated into a variety of programming languages to get a parsing library.

PHP source code to parse NT-MDT palette format

NtMdtPal.php

<?php
// This is a generated file! Please edit source .ksy file and use kaitai-struct-compiler to rebuild

/**
 * It is a color scheme for visualising SPM scans.
 */

namespace {
    class NtMdtPal extends \Kaitai\Struct\Struct {
        public function __construct(\Kaitai\Struct\Stream $_io, \Kaitai\Struct\Struct $_parent = null, \NtMdtPal $_root = null) {
            parent::__construct($_io, $_parent, $_root);
            $this->_read();
        }

        private function _read() {
            $this->_m_signature = $this->_io->readBytes(26);
            if (!($this->signature() == "\x4E\x54\x2D\x4D\x44\x54\x20\x50\x61\x6C\x65\x74\x74\x65\x20\x46\x69\x6C\x65\x20\x20\x31\x2E\x30\x30\x21")) {
                throw new \Kaitai\Struct\Error\ValidationNotEqualError("\x4E\x54\x2D\x4D\x44\x54\x20\x50\x61\x6C\x65\x74\x74\x65\x20\x46\x69\x6C\x65\x20\x20\x31\x2E\x30\x30\x21", $this->signature(), $this->_io(), "/seq/0");
            }
            $this->_m_count = $this->_io->readU4be();
            $this->_m_meta = [];
            $n = $this->count();
            for ($i = 0; $i < $n; $i++) {
                $this->_m_meta[] = new \NtMdtPal\Meta($this->_io, $this, $this->_root);
            }
            $this->_m_something2 = $this->_io->readBytes(1);
            $this->_m_tables = [];
            $n = $this->count();
            for ($i = 0; $i < $n; $i++) {
                $this->_m_tables[] = new \NtMdtPal\ColTable($i, $this->_io, $this, $this->_root);
            }
        }
        protected $_m_signature;
        protected $_m_count;
        protected $_m_meta;
        protected $_m_something2;
        protected $_m_tables;
        public function signature() { return $this->_m_signature; }
        public function count() { return $this->_m_count; }
        public function meta() { return $this->_m_meta; }
        public function something2() { return $this->_m_something2; }
        public function tables() { return $this->_m_tables; }
    }
}

namespace NtMdtPal {
    class Meta extends \Kaitai\Struct\Struct {
        public function __construct(\Kaitai\Struct\Stream $_io, \NtMdtPal $_parent = null, \NtMdtPal $_root = null) {
            parent::__construct($_io, $_parent, $_root);
            $this->_read();
        }

        private function _read() {
            $this->_m_unkn00 = $this->_io->readBytes(3);
            $this->_m_unkn01 = $this->_io->readBytes(2);
            $this->_m_unkn02 = $this->_io->readBytes(1);
            $this->_m_unkn03 = $this->_io->readBytes(1);
            $this->_m_colorsCount = $this->_io->readU2le();
            $this->_m_unkn10 = $this->_io->readBytes(2);
            $this->_m_unkn11 = $this->_io->readBytes(1);
            $this->_m_unkn12 = $this->_io->readBytes(2);
            $this->_m_nameSize = $this->_io->readU2be();
        }
        protected $_m_unkn00;
        protected $_m_unkn01;
        protected $_m_unkn02;
        protected $_m_unkn03;
        protected $_m_colorsCount;
        protected $_m_unkn10;
        protected $_m_unkn11;
        protected $_m_unkn12;
        protected $_m_nameSize;

        /**
         * usually 0s
         */
        public function unkn00() { return $this->_m_unkn00; }
        public function unkn01() { return $this->_m_unkn01; }
        public function unkn02() { return $this->_m_unkn02; }

        /**
         * usually 0s
         */
        public function unkn03() { return $this->_m_unkn03; }
        public function colorsCount() { return $this->_m_colorsCount; }

        /**
         * usually 0s
         */
        public function unkn10() { return $this->_m_unkn10; }

        /**
         * usually 4
         */
        public function unkn11() { return $this->_m_unkn11; }

        /**
         * usually 0s
         */
        public function unkn12() { return $this->_m_unkn12; }
        public function nameSize() { return $this->_m_nameSize; }
    }
}

namespace NtMdtPal {
    class Color extends \Kaitai\Struct\Struct {
        public function __construct(\Kaitai\Struct\Stream $_io, \NtMdtPal\ColTable $_parent = null, \NtMdtPal $_root = null) {
            parent::__construct($_io, $_parent, $_root);
            $this->_read();
        }

        private function _read() {
            $this->_m_red = $this->_io->readU1();
            $this->_m_unkn = $this->_io->readU1();
            $this->_m_blue = $this->_io->readU1();
            $this->_m_green = $this->_io->readU1();
        }
        protected $_m_red;
        protected $_m_unkn;
        protected $_m_blue;
        protected $_m_green;
        public function red() { return $this->_m_red; }
        public function unkn() { return $this->_m_unkn; }
        public function blue() { return $this->_m_blue; }
        public function green() { return $this->_m_green; }
    }
}

namespace NtMdtPal {
    class ColTable extends \Kaitai\Struct\Struct {
        public function __construct(int $index, \Kaitai\Struct\Stream $_io, \NtMdtPal $_parent = null, \NtMdtPal $_root = null) {
            parent::__construct($_io, $_parent, $_root);
            $this->_m_index = $index;
            $this->_read();
        }

        private function _read() {
            $this->_m_size1 = $this->_io->readU1();
            $this->_m_unkn = $this->_io->readU1();
            $this->_m_title = \Kaitai\Struct\Stream::bytesToStr($this->_io->readBytes($this->_root()->meta()[$this->index()]->nameSize()), "UTF-16");
            $this->_m_unkn1 = $this->_io->readU2be();
            $this->_m_colors = [];
            $n = ($this->_root()->meta()[$this->index()]->colorsCount() - 1);
            for ($i = 0; $i < $n; $i++) {
                $this->_m_colors[] = new \NtMdtPal\Color($this->_io, $this, $this->_root);
            }
        }
        protected $_m_size1;
        protected $_m_unkn;
        protected $_m_title;
        protected $_m_unkn1;
        protected $_m_colors;
        protected $_m_index;
        public function size1() { return $this->_m_size1; }
        public function unkn() { return $this->_m_unkn; }
        public function title() { return $this->_m_title; }
        public function unkn1() { return $this->_m_unkn1; }
        public function colors() { return $this->_m_colors; }
        public function index() { return $this->_m_index; }
    }
}