org.openimaj.io

Interface ReadableASCII

All Known Subinterfaces:

CachableASCII, Clusters, Coordinate, FeatureVector, LocalFeature<L,T>, Location, Point2d, Point3d, Readable, ReadWriteable, ReadWriteableASCII, ScaleSpacePoint, SpatialClusters<DATATYPE>

All Known Implementing Classes:

AbstractPoint2d, AffineInterestPointKeypoint, AffineParams, AffineSimulationKeypoint, AffineSimulationKeypoint.AffineSimulationKeypointLocation, ArrayFeatureVector, ByteCentroidsResult, ByteDSIFTKeypoint, ByteFV, ByteKMeans.Result, CircularInterestPointKeypoint, ClusterLimitedIntRAC, ConnectedComponent, DBSCANClusters, Document, DoubleCentroidsResult, DoubleDBSCANClusters, DoubleFV, DoubleKMeans.Result, DoublePoint2dImpl, DoubleTimeSeries, DoubleTimeSeriesCollection, EllipticInterestPointData, EnumFV, Feature, FeatureVectorCentroidsResult, FeatureVectorKMeans.Result, FloatCentroidsResult, FloatDSIFTKeypoint, FloatFV, FloatKeypoint, FloatKMeans.Result, FloatLocalFeatureAdaptor, FValuePixel, GeneralJSON, GeneralJSONRDF, GeneralJSONTwitter, GeneralJSONTwitterRawText, GenericValuePixel, HierarchicalByteKMeansResult, HierarchicalDoubleKMeansResult, HierarchicalFloatKMeansResult, HierarchicalIntKMeansResult, HierarchicalLongKMeansResult, HierarchicalShortKMeansResult, Histogram, ImageCollectionConfig, ImageCollectionConfig, ImageCollectionState, IndexClusters, IntCentroidsResult, InterestPointData, InterestPointKeypoint, IntFV, IntKMeans.Result, IntRAC, IntRandomForest, IntValuePixel, JacardIndex, KDTreeClusters, Keypoint, KeypointLocation, LocalFeatureImpl, LongCentroidsResult, LongFV, LongKMeans.Result, MinMaxKeypoint, MinMaxKeypoint.MinMaxKeypointLocation, MultidimensionalByteFV, MultidimensionalDoubleFV, MultidimensionalFloatFV, MultidimensionalHistogram, MultidimensionalIntFV, MultidimensionalLongFV, MultidimensionalShortFV, OrientedFeatureVector, PayloadCoordinate, Pixel, PixelSet, PixelsFeature, Point2dImpl, Point3dImpl, QuantisedAffineSimulationKeypoint, QuantisedKeypoint, QuantisedLocalFeature, ReadWriteableByte, ReadWriteableDouble, ReadWriteableFloat, ReadWriteableInt, ReadWriteableLong, ReadWriteableMatrix, ReadWriteableShort, ReadWriteableString, Rectangle, Rectangle3D, ScaleSpaceLocation, ShortCentroidsResult, ShortFV, ShortKMeans.Result, SIFTGeoKeypoint, SIFTGeoKeypoint.SIFTGeoLocation, SimilarityMatrix, SparseBinSearchByteArray, SparseBinSearchDoubleArray, SparseBinSearchFloatArray, SparseBinSearchIntArray, SparseBinSearchLongArray, SparseBinSearchShortArray, SparseByteArray, SparseByteFV, SparseDoubleArray, SparseDoubleFV, SparseFloatArray, SparseFloatFV, SparseHashedByteArray, SparseHashedDoubleArray, SparseHashedFloatArray, SparseHashedIntArray, SparseHashedLongArray, SparseHashedShortArray, SparseIntArray, SparseIntFV, SparseLongArray, SparseLongFV, SparseShortArray, SparseShortFV, SpatialLocation, SpectralIndexedClusters, SphericalKMeansResult, StatusConsumption, StreamJSONStatusList.ReadableWritableJSON, TernaryPlot.TernaryData, TFF, TokenPairCount, TokenPairUnaryCount, TrueLanguageTwitterStatus, USMFStatus, ValuePixel, WordDFIDF, WordDFIDFTimeSeries, WordDFIDFTimeSeriesCollection, WordDFIDFValue, WritableEnumCounter, WritablePairEnum, WriteableFailedURL, WriteableImageOutput, YahooFinanceData

public interface ReadableASCII

Interface for objects capable of deserialising themselves from ascii formats. IMPORTANT: All Readable objects must have a no-arguments constructor, but this CAN BE protected or private.

Author:

Jonathon Hare (jsh2@ecs.soton.ac.uk), Sina Samangooei (ss@ecs.soton.ac.uk)

Method Summary

Modifier and Type	Method and Description
String	asciiHeader() Header for ascii input.
void	readASCII(Scanner in) Read internal state from in.

Method Detail

readASCII

void readASCII(Scanner in)
        throws IOException

Read internal state from in.

Parameters:

in - source to read from.

Throws:

IOException - an error reading input

asciiHeader

String asciiHeader()

Header for ascii input. Will be automatically read by IOUtils when using readASCII().

Returns:

header