otbSOMModel.hxx 6.25 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
/*
 * Copyright (C) 2005-2017 Centre National d'Etudes Spatiales (CNES)
 *
 * This file is part of Orfeo Toolbox
 *
 *     https://www.orfeo-toolbox.org/
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
20 21
#ifndef otbSOMModel_hxx
#define otbSOMModel_hxx
22

23
#include "otbSOMModel.h"
24
#include "otbSOM.h"
25 26

#include "itkMacro.h"
27 28
#include "itkImageRegionIterator.h"
#include "itkImageRegionConstIterator.h"
29 30
#include "itkImage.h"

31 32
#include <fstream>

33 34 35
namespace otb
{

36 37 38 39
namespace internal
{
template<typename T>
std::ostream& BinaryWrite(std::ostream& stream, const T& value)
40
{
41
  return stream.write(reinterpret_cast<const char*>(&value), sizeof(T));
42 43
}

44
std::ostream& BinaryWriteString(std::ofstream& stream, const std::string& value)
45
{
46
  return stream.write(value.c_str(), value.length());
47 48
}

49 50
template<typename T>
std::istream & BinaryRead(std::istream& stream, T& value)
51
{
52 53 54
  return stream.read(reinterpret_cast<char*>(&value), sizeof(T));
}
} // end of namespace internal
55

56
template <class TInputValue, unsigned int MapDimension>
57
SOMModel<TInputValue,  MapDimension>::SOMModel()
58
{
59
  this->m_Dimension = MapType::ImageDimension;
60 61
}

62
template <class TInputValue, unsigned int MapDimension>
63
SOMModel<TInputValue, MapDimension>::~SOMModel()
64 65 66
{
}

67 68 69 70 71 72
template <class TInputValue, unsigned int MapDimension>
void
SOMModel<TInputValue,  MapDimension>::Train()
{
  typedef otb::SOM<InputListSampleType, MapType>    EstimatorType;
  typename EstimatorType::Pointer estimator = EstimatorType::New();
73
  estimator->SetListSample(this->GetInputListSample());
74 75 76 77 78 79 80 81
  estimator->SetMapSize(m_MapSize);
  estimator->SetNeighborhoodSizeInit(m_NeighborhoodSizeInit);
  estimator->SetNumberOfIterations(m_NumberOfIterations);
  estimator->SetBetaInit(m_BetaInit);
  estimator->SetBetaEnd(m_BetaEnd);
  estimator->SetMaxWeight(m_MaxWeight);
  estimator->Update();
  m_SOMMap = estimator->GetOutput();
82 83
}

84 85 86 87 88 89 90 91 92 93 94 95 96
template <class TInputValue, unsigned int MapDimension>
bool
SOMModel<TInputValue, MapDimension>::CanReadFile(const std::string & filename)
{
  try
    {
    this->Load(filename);
    }
  catch(...)
    {
    return false;
    }
  return true;
97 98
}

99
template <class TInputValue, unsigned int MapDimension>
100 101
bool
SOMModel<TInputValue, MapDimension>::CanWriteFile(const std::string & /*filename*/)
102
{
103
  return true;
104 105
}

106
template <class TInputValue, unsigned int MapDimension>
107 108
void
SOMModel<TInputValue, MapDimension>::Save(const std::string & filename, const std::string & /*name*/)
109
{
110 111 112 113 114 115 116 117 118
  itk::ImageRegionConstIterator<MapType> inputIterator(m_SOMMap,m_SOMMap->GetLargestPossibleRegion());
  inputIterator.GoToBegin();
  std::ofstream ofs(filename, std::ios::binary);
  internal::BinaryWriteString(ofs,"som"); 
  internal::BinaryWrite(ofs,static_cast<unsigned int>(MapDimension));
  SizeType size = m_SOMMap->GetLargestPossibleRegion().GetSize() ;
  for (size_t i=0;i<MapDimension;i++)
    {
    internal::BinaryWrite(ofs,size[i]);
119 120
    }
    
121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149
  internal::BinaryWrite(ofs,inputIterator.Get().GetNumberOfElements());
  while(!inputIterator.IsAtEnd())
    {
    InputSampleType vect = inputIterator.Get();
    for (size_t i=0;i<vect.GetNumberOfElements();i++)
      {
      internal::BinaryWrite(ofs,vect[i]);
      } 
    ++inputIterator;
    }
  ofs.close();

  // output the map vectors in a txt file
  if (this->m_WriteMap == true)
    {
    std::ofstream otxt(filename+".txt");
    inputIterator.GoToBegin();
    while(!inputIterator.IsAtEnd())
      {
      InputSampleType vect = inputIterator.Get();
      for (size_t i=0;i<vect.GetNumberOfElements();i++)
        {
        otxt << vect[i] << " ";
        } 
      otxt << std::endl;
      ++inputIterator;
      }
    otxt.close();
    }
150 151
}

152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209
template <class TInputValue, unsigned int MapDimension>
void
SOMModel<TInputValue, MapDimension>::Load(const std::string & filename, const std::string & /*name*/)
{
  std::ifstream ifs(filename, std::ios::binary);
  
  /**  Read the model key (should be som) */
  char s[]="   ";
  for (int i=0; i<3; i++)
    {  
    internal::BinaryRead(ifs,s[i]);
    }
  std::string modelType(s);
  /** Read the dimension of the map (should be equal to MapDimension) */
  
  unsigned int dimension;
  internal::BinaryRead(ifs,dimension);
  if (modelType != "som" || dimension != MapDimension)
    {
    itkExceptionMacro(<< "Error opening " << filename.c_str() );
    }

  SizeType size;
  itk::Index< MapDimension > index;
  for (unsigned int i=0 ; i<MapDimension; i++)
    {
    internal::BinaryRead(ifs,size[i]);
    index[i]=0;
    }
  unsigned int numberOfElements;
  internal::BinaryRead(ifs,numberOfElements);
  m_SOMMap = MapType::New();
  typename MapType::RegionType region;
  region.SetSize( size );
  m_SOMMap->SetNumberOfComponentsPerPixel(numberOfElements);
  region.SetIndex( index );
  m_SOMMap->SetRegions( region );
  m_SOMMap->Allocate();

  itk::ImageRegionIterator<MapType> outputIterator(m_SOMMap,region);
  outputIterator.GoToBegin();
  std::string value;
  while(!outputIterator.IsAtEnd())
    {
    InputSampleType  vect(numberOfElements);
    for (unsigned int i=0 ; i<numberOfElements; i++)
      {
      // InputValue type is not the same during training anddimredvector.
      float v;
      internal::BinaryRead(ifs,v);
      vect[i] = static_cast<double>(v);
      }
    outputIterator.Set(vect);
    ++outputIterator;
    }
  ifs.close();
  this->m_Dimension = MapType::ImageDimension;
}
210

211 212
template <class TInputValue, unsigned int MapDimension>
typename SOMModel<TInputValue, MapDimension>::TargetSampleType
213 214
SOMModel<TInputValue, MapDimension>::DoPredict(
  const InputSampleType & value,
215 216
  ConfidenceValueType * /*quality*/,
  ProbaSampleType * /*proba*/) const
217 218 219 220 221 222 223 224 225 226
{
  TargetSampleType target;
  target.SetSize(this->m_Dimension);

  auto winner =m_SOMMap->GetWinner(value);
  for (unsigned int i=0; i< this->m_Dimension ;i++)
    {
    target[i] = winner.GetElement(i); 
    }
  return target;
227 228 229 230
}

} // namespace otb
#endif