Документация

Classdef

The LanAdapter класс начинается с ключевого слова classdef. The classdef раздел определяет имя класса и указывает, что LanAdapter наследует от ImageAdapter суперкласс. Наследование от ImageAdapter позволяет новому классу:

Свойства

Следуя classdef раздел, LanAdapter класс содержит два блока свойств классов. Первый блок содержит свойства, которые являются публично видимыми, но не изменяемыми публично. Второй блок содержит полностью общественную собственность. The LanAdapter класс хранит некоторую информацию из заголовка файла как свойства класса. Другие классы, которые также наследуют от ImageAdapter, но которые поддерживают различные форматы файлов, могут иметь различные свойства.

classdef LanAdapter < ImageAdapter
   properties(GetAccess = public, SetAccess = private)
      Filename
      NumBands
   end

   properties(Access = public)
      SelectedBands
   end

В дополнение к свойствам, заданным в LanAdapter.m, класс наследует ImageSize свойство от ImageAdapter суперкласс. Новый класс устанавливает ImageSize свойство в конструкторе.

Методы: Конструктор классов

Конструктор классов инициализирует LanAdapter объект. The LanAdapter конструктор анализирует информацию о заголовке файла LAN и устанавливает свойства класса. Реализуйте конструктор, метод класса, внутри methods блок.

Конструктор содержит большую часть того же кода, используемого для анализа заголовка файла LAN. The LanAdapter класс поддерживает только uint8 файлы типов данных, поэтому конструктор проверяет тип пакета файла LAN, а также заголовок. Оставшиеся сведения хранятся в свойствах класса. Метод, ответственный за чтение пиксельных данных, использует эти свойства. The SelectedBands свойство позволяет вам считать подмножество полос с набором по умолчанию, чтобы считать все полосы.

   methods

      function obj = LanAdapter(fname)
         % LanAdapter constructor for LanAdapter class.
         % When creating a new LanAdapter object, read the file
         % header to validate the file as well as save some image
         % properties for later use.
            
         % Open the file.
         obj.Filename = fname;
         fid = fopen(fname,'r');

         % Verify that the file begins with the headword 'HEADER' or
         % 'HEAD74', as per the Erdas LAN file specification.
         headword = fread(fid,6,'uint8=>char');
         if ~(strcmp(headword','HEADER') || strcmp(headword',...
               'HEAD74'))
            error('Invalid LAN file header.');
         end

         % Read the data type from the header.
         pack_type = fread(fid,1,'uint16',0,'ieee-le');
         if ~isequal(pack_type,0)
            error(['Unsupported pack type. The LanAdapter example ' ...
               'only supports reading uint8 data.']);
         end

         % Provide band information.
         obj.NumBands = fread(fid,1,'uint16',0,'ieee-le');
         % By default, return all bands of data
         obj.SelectedBands = 1:obj.NumBands;

         % Specify image width and height.
         unused_field = fread(fid,6,'uint8',0,'ieee-le');
         width = fread(fid,1,'uint32',0,'ieee-le');
         height = fread(fid,1,'uint32',0,'ieee-le');
         obj.ImageSize = [height width];

         % Close the file handle
         fclose(fid);

   end % LanAdapter 

Методы: Необходимые

Классы адаптеров имеют два необходимых метода, заданных в абстрактном суперклассе, ImageAdapter. Все классы Image Adapter должны реализовать эти методы. The blockproc функция использует первый метод, readRegion, для чтения блоков данных из файлов на диске. Второй метод, closeвыполняет необходимую очистку объекта Image Adapter.

   function data = readRegion(obj, region_start, region_size)
      % readRegion reads a rectangular block of data from the file.

      % Prepare various arguments to MULTIBANDREAD.
      header_size = 128;
      rows = region_start(1):(region_start(1) + region_size(1) - 1);
      cols = region_start(2):(region_start(2) + region_size(2) - 1);
 
      % Call MULTIBANDREAD to get data.
      full_size = [obj.ImageSize obj.NumBands];
      data = multibandread(obj.Filename, full_size,...
     'uint8=>uint8', header_size, 'bil', 'ieee-le',...
         {'Row',   'Direct', rows},...
         {'Column','Direct', cols},...
         {'Band',  'Direct', obj.SelectedBands});
 
   end % readRegion

readRegion имеет два входных параметров, region_start и region_size. The region_start аргумент, двухэлементный вектор в форме [row col], задает первый пиксель в запрос блоке данных. The region_size аргумент, двухэлементный вектор в форме [num_rows num_cols], определяет размер запрашиваемого блока данных. The readRegion метод использует эти входные параметры, чтобы считать и вернуть запрошенный блок данных с изображения.

The readRegion метод реализован по-разному для различных форматов файлов, в зависимости от того, какие инструменты доступны для чтения конкретных файлов. The readRegion метод для LanAdapter класс использует входные параметры, чтобы подготовить пользовательский вход для multibandread. Для файлов LAN, multibandread предоставляет удобный способ чтения конкретных подсекций изображения.

Другой необходимый метод close. The close метод LanAdapter класс появляется следующим образом:

      function close(obj)
      % Close the LanAdapter object. This method is a part
      % of the ImageAdapter interface and is required.
      % Since the readRegion method is "atomic", there are
      % no open file handles to close, so this method is empty.

      end
        
   end % public methods
    
end % LanAdapter

Как указывают комментарии, close метод для LanAdapter делать нечего, так что close пуст. The multibandread функция не требует обслуживания открытых указателей на файлы, поэтому close метод не имеет указателей для очистки. Классы Image Adapter для других форматов файлов могут иметь более существенные close методы, включая закрытие указателей на файлы и выполнение других обязанностей по очистке классов.

Методы (необязательно)

Как написано, LanAdapter класс может только читать файлы LAN, а не записывать их. Если вы хотите записать выход в файл формата LAN или другой файл с форматом, который blockproc не поддерживает, реализуйте опционально writeRegion способ. Затем можно задать класс как 'Destination' параметр в blockproc и запишите выход в файл выбранного формата.

Подпись writeRegion Способ заключается в следующем:

function [] = writeRegion(obj, region_start, region_data)

Первый аргумент, region_start, указывает первый пиксель блока, который writeRegion метод записывает. Второй аргумент, region_data, содержит новые данные, которые метод записывает в файл.

Классы, которые реализуют writeRegion метод может быть более комплексным, чем LanAdapter. При создании объекта Image Adapter с возможностью записи классы часто несут дополнительную ответственность за создание новых файлов в конструкторе классов. Это создание файла требует более сложного синтаксиса в конструкторе, где вам потенциально нужно задать размер и тип данных нового файла, который вы хотите создать. Конструкторы, которые создают новые файлы, могут также столкнуться с другими проблемами, такими как разрешения файлов операционной системы или потенциально сложный код создания файлов.