bsfm::Image Class Reference

#include <image.h>

Public Types
typedef std::shared_ptr< Image >	Ptr
typedef std::shared_ptr< const Image >	ConstPtr

Public Member Functions
	Image ()
	~Image ()
	Image (const Image &other)
	Image (size_t width, size_t height, size_t channels)
	Image (const std::string &filename, bool grayscale=false)
	Image (const cv::Mat &other)
template<typename T >
T &	at (size_t u, size_t v)
template<typename T >
const T &	at (size_t u, size_t v) const
void	ToCV (cv::Mat &out) const
void	FromCV (const cv::Mat &in)
void	ToEigen (MatrixXf &eigen_out)
void	Read (const std::string &filename, bool grayscale=false)
void	Write (const std::string &filename) const
size_t	Width () const
size_t	Height () const
size_t	Cols () const
size_t	Rows () const
size_t	Channels () const
bool	IsColor () const
void	Resize (double scale)
void	Resize (size_t new_width, size_t new_height)
void	Transpose ()
void	RotateClockwise ()
void	RotateCounterClockwise ()
void	FlipLR ()
void	FlipUD ()
void	ConvertToGrayscale ()
void	ConvertToRGB ()
void	ImShow (const std::string &window_name=std::string(), unsigned int wait_time=0)

Private Attributes
bool	grayscale_
std::shared_ptr< cv::Mat >	image_

Detailed Description

Definition at line 62 of file image.h.

Member Typedef Documentation

typedef std::shared_ptr<const Image> bsfm::Image::ConstPtr

Definition at line 65 of file image.h.

typedef std::shared_ptr<Image> bsfm::Image::Ptr

Definition at line 64 of file image.h.

Constructor & Destructor Documentation

bsfm::Image::Image ( )

inline

Definition at line 67 of file image.h.

: grayscale_(false) {}

bsfm::Image::~Image ( )

inline

Definition at line 68 of file image.h.

{}

bsfm::Image::Image

(

const Image &

other

)

Definition at line 43 of file image.cpp.

                               : grayscale_(false) {
  image_ = other.image_;
  grayscale_ = other.grayscale_;
}

bsfm::Image::Image	(	size_t	width,
		size_t	height,
		size_t	channels
	)

Definition at line 49 of file image.cpp.

                                                         {
  if (channels == 1) {
    grayscale_ = true;
    image_ = std::shared_ptr<cv::Mat>(new cv::Mat(width, height, CV_32F, 0.f));
  } else {
    grayscale_ = false;
    image_ = std::shared_ptr<cv::Mat>(
        new cv::Mat(width, height, CV_32FC3, CV_RGB(0.f, 0.f, 0.f)));
  }
}

bsfm::Image::Image ( const std::string &  filename, bool  grayscale = false  )

explicit

Definition at line 61 of file image.cpp.

                                                      : grayscale_(false) {
  image_ = std::shared_ptr<cv::Mat>(new cv::Mat());
  Read(filename, grayscale);
}

bsfm::Image::Image ( const cv::Mat &  other )

explicit

Definition at line 67 of file image.cpp.

                               {
  image_ = std::shared_ptr<cv::Mat>(new cv::Mat(other));
  grayscale_ = (this->Channels() == 1);
}

Member Function Documentation

template<typename T >

T & bsfm::Image::at ( size_t  u, size_t  v  )

inline

Definition at line 147 of file image.h.

                               {
  CHECK_NOTNULL(image_.get());
  return image_->template at<T>(u, v);
}

template<typename T >

const T & bsfm::Image::at ( size_t  u, size_t  v  ) const

inline

Definition at line 153 of file image.h.

                                           {
  CHECK_NOTNULL(image_.get());
  return image_->template at<T>(u, v);
}

size_t bsfm::Image::Channels

(

)

const

Definition at line 123 of file image.cpp.

                             {
  CHECK(image_.get()) << "Image data is not allocated.";
  return image_->channels();
}

size_t bsfm::Image::Cols ( ) const

inline

Definition at line 103 of file image.h.

{ return Width(); }

void bsfm::Image::ConvertToGrayscale

(

)

Definition at line 166 of file image.cpp.

                               {
  CHECK(image_.get()) << "Image data is not allocated.";

  if (grayscale_) {
    VLOG(1) << "Cannot convert image to grayscale, image is already grayscale.";
    return;
  }

  cv::cvtColor(*image_, *image_, CV_RGB2GRAY);
  grayscale_ = true;
}

void bsfm::Image::ConvertToRGB

(

)

Definition at line 178 of file image.cpp.

                         {
  CHECK(image_.get()) << "Image data is not allocated.";

  if (!grayscale_) {
    VLOG(1) << "Cannot convert image to RGB, image is already RGB.";
    return;
  }

  cv::cvtColor(*image_, *image_, CV_GRAY2RGB);
  grayscale_ = false;
}

void bsfm::Image::FlipLR

(

)

Definition at line 156 of file image.cpp.

                   {
  CHECK(image_.get()) << "Image data is not allocated.";
  cv::flip(*image_, *image_, 1 /*about vertical axis*/);
}

void bsfm::Image::FlipUD

(

)

Definition at line 161 of file image.cpp.

                   {
  CHECK(image_.get()) << "Image data is not allocated.";
  cv::flip(*image_, *image_, 0 /*about horizontal axis*/);
}

void bsfm::Image::FromCV

(

const cv::Mat &

in

)

Definition at line 79 of file image.cpp.

                                  {
  CHECK(image_.get()) << "Image data is not allocated.";

  // Convert from BGR (default in OpenCV) to RGB (internal representation).
  cv::cvtColor(in, *image_, CV_BGR2RGB);
}

size_t bsfm::Image::Height

(

)

const

Definition at line 118 of file image.cpp.

                           {
  CHECK(image_.get()) << "Image data is not allocated.";
  return image_->rows;
}

void bsfm::Image::ImShow	(	const std::string &	window_name = std::string(),
		unsigned int	wait_time = 0
	)

Definition at line 190 of file image.cpp.

                                                                       {
  CHECK(image_.get()) << "Image data is not allocated.";

  cv::namedWindow(window_name.c_str(), CV_WINDOW_AUTOSIZE);

  // If the image is not grayscale, convert it from RGB to BGR.
  if (!grayscale_) {
    cv::Mat bgr_image;
    ToCV(bgr_image);
    cv::imshow(window_name.c_str(), bgr_image);
  } else {
    cv::imshow(window_name.c_str(), *image_);
  }

  cv::waitKey(wait_time);
}

bool bsfm::Image::IsColor ( ) const

inline

Definition at line 106 of file image.h.

{ return !grayscale_; }

void bsfm::Image::Read	(	const std::string &	filename,
		bool	grayscale = false
	)

Definition at line 91 of file image.cpp.

                                                          {
  if (grayscale) {
    *image_ = cv::imread(filename.c_str(), CV_LOAD_IMAGE_GRAYSCALE);

    // Convert from unsigned to floating point.
    image_->convertTo(*image_, CV_32F, 1.f / 255.f);
  } else {
    *image_ = cv::imread(filename.c_str(), CV_LOAD_IMAGE_COLOR);

    // Convert from unsigned to floating point.
    image_->convertTo(*image_, CV_32FC3, 1.f / 255.f);
  }
  CHECK(image_->data) << "Unable to read image file.";

  // Convert from BGR (default in OpenCV) to RGB.
  cv::cvtColor(*image_, *image_, CV_BGR2RGB);
}

void bsfm::Image::Resize

(

double

scale

)

Definition at line 128 of file image.cpp.

                               {
  CHECK(image_.get()) << "Image data is not allocated.";
  cv::resize(*image_, *image_, cv::Size(), scale, scale, CV_INTER_LANCZOS4);
}

void bsfm::Image::Resize	(	size_t	new_width,
		size_t	new_height
	)

Definition at line 133 of file image.cpp.

                                                      {
  CHECK(image_.get()) << "Image data is not allocated.";
  cv::resize(*image_, *image_, cv::Size(new_width, new_height),
             CV_INTER_LANCZOS4);
}

void bsfm::Image::RotateClockwise

(

)

Definition at line 144 of file image.cpp.

                            {
  CHECK(image_.get()) << "Image data is not allocated.";
  Transpose();
  FlipLR();
}

void bsfm::Image::RotateCounterClockwise

(

)

Definition at line 150 of file image.cpp.

                                   {
  CHECK(image_.get()) << "Image data is not allocated.";
  Transpose();
  FlipUD();
}

size_t bsfm::Image::Rows ( ) const

inline

Definition at line 104 of file image.h.

{ return Height(); }

void bsfm::Image::ToCV

(

cv::Mat &

out

)

const

Definition at line 72 of file image.cpp.

                                 {
  CHECK(image_.get()) << "Image data is not allocated.";

  // Convert from RGB (internal representation) to BGR (default in OpenCV).
  cv::cvtColor(*image_, out, CV_RGB2BGR);
}

void bsfm::Image::ToEigen

(

MatrixXf &

eigen_out

)

Definition at line 86 of file image.cpp.

                                       {
  CHECK(image_.get()) << "Image data is not allocated.";
  OpenCVToEigenMat(*image_, eigen_out);
}

void bsfm::Image::Transpose

(

)

Definition at line 139 of file image.cpp.

                      {
  CHECK(image_.get()) << "Image data is not allocated.";
  cv::transpose(*image_, *image_);
}

size_t bsfm::Image::Width

(

)

const

Definition at line 113 of file image.cpp.

                          {
  CHECK(image_.get()) << "Image data is not allocated.";
  return image_->cols;
}

void bsfm::Image::Write

(

const std::string &

filename

)

const

Definition at line 109 of file image.cpp.

                                                 {
  cv::imwrite(filename.c_str(), *image_);
}

Member Data Documentation

bool bsfm::Image::grayscale_

private

Definition at line 128 of file image.h.

std::shared_ptr<cv::Mat> bsfm::Image::image_

private

Definition at line 129 of file image.h.

---

The documentation for this class was generated from the following files:

• /Users/eanelson/Git/berkeley_sfm/src/cpp/image/image.h
• /Users/eanelson/Git/berkeley_sfm/src/cpp/image/image.cpp