inv_source_estimate_token.h File Reference

Tokenization and de-tokenization of InvSourceEstimate for foundation-model interfacing. More...

#include "inv_global.h"
#include "inv_token.h"
#include <vector>

Include dependency graph for inv_source_estimate_token.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Namespaces
namespace	INVLIB
	Inverse source estimation (MNE, dSPM, sLORETA, dipole fitting).

Functions
INVSHARED_EXPORT std::vector< InvToken >	INVLIB::tokenize (const InvSourceEstimate &estimate, const InvTokenizeOptions &options=InvTokenizeOptions())
	Serialise an InvSourceEstimate into a flat token sequence.
INVSHARED_EXPORT InvSourceEstimate	INVLIB::fromTokens (const std::vector< InvToken > &tokens)
	Reconstruct an InvSourceEstimate from a token sequence.

Detailed Description

Tokenization and de-tokenization of InvSourceEstimate for foundation-model interfacing.

Author

Christoph Dinh chdin.nosp@m.h@nm.nosp@m.r.mgh.nosp@m..har.nosp@m.vard..nosp@m.edu

Since

2.0.0

Date

March, 2026

LICENSE

Copyright (C) 2026, Christoph Dinh. All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

• Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
• Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
• Neither the name of MNE-CPP authors nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Provides free functions to serialise an InvSourceEstimate into a flat token sequence (see inv_token.h for the vocabulary) and to reconstruct an estimate from such a sequence. These are the public entry points; all vocabulary IDs, the InvToken struct, and the InvTokenizeOptions knobs live in inv_token.h.

Definition in file inv_source_estimate_token.h.